Skip to content

w0rm29/chatbot-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chat API

A Spring Boot application that provides a REST API for handling chat-based interactions, including Retrieval-Augmented Generation (RAG) capabilities.

Features

  • RESTful API with Spring Boot
  • JSON-based communication
  • Retrieval-Augmented Generation (RAG) support
  • Easily extendable architecture
  • Supports Spring Boot 3+, Java 17+
  • Maven/Gradle build system

Prerequisites

Ensure you have the following installed:


🛠️ Setup & Installation

Clone the repository:

git clone https://github.com/w0rm29/chatbot-app.git
cd chatbot-app

Run

./mvnw spring-boot:run

API Endpoints

POST /chat/ask
Content-Type: application/json
Request-Body
{
  "message": "Hello, chatbot!"
}

Project Structure

Explanation of Key Directories and Files:

  • controller/ → Handles REST API requests.
  • service/ → Contains business logic.
  • model/ → Defines request/response data models.
  • resources/ → Stores application configuration.
    • application.yml → Preferred configuration file using YAML format.
    • application.properties → Alternative properties-based configuration.
  • test/ → Contains unit and integration tests.
  • pom.xml / build.gradle → Manages dependencies.
  • README.md → Documentation.

This structure follows best practices for a Spring Boot application, making it modular and easy to maintain.


🛠️ Made with ❤️

Made with ❤️ using:

  • Spring Boot – Backend framework
  • LangChain – AI/LLM Orchestration
  • Ollama – Local LLM Inference
  • RAG (Retrieval-Augmented Generation) – Context-aware chat intelligence

Releases

No releases published

Packages

No packages published

Languages