Skip to content

Commit c871a1c

Browse files
committed
Add readme
1 parent bbe5edc commit c871a1c

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ The root directory contains configuration files and documentation for the overal
212212

213213
6. Go to `http://localhost:8000/docs` to access the FastAPI Swagger documentation of the backend.
214214

215-
### Usage
215+
### Frontend usage
216216

217217
1. Enter your message in the chat interface on the Streamlit application.
218218
2. Click the "Send" button to send the message to the backend API.
@@ -231,6 +231,15 @@ The interface send all history of the chat to the backend API to generate the re
231231

232232
For clear the chat history, you can click the "New Chat" button.
233233

234+
### Backend API Usage
235+
236+
The backend API is a FastAPI application that handles the chatbot logic and interacts with the TinyLlama model to generate responses. The API exposes the following endpoints:
237+
238+
- **POST /api/v1/chat**: This endpoint receives a chat messages from the frontend and generates a response using the TinyLlama model. View swuaager documentation in `http://localhost:8000/docs` for more information.
239+
240+
- **GET /docs**: This endpoint provides the Swagger documentation for the backend API. You can access it by going to `http://localhost:8000/docs` in your web browser.
241+
242+
234243
### Building the Docker Image Locally
235244

236245
To build the Docker image for the backend FastAPI application, run the following command:

0 commit comments

Comments
 (0)