Update README.md

README.md

@@ -16,6 +16,13 @@ This project implements a chatbot using FastAPI and a pre-trained language model
 
 All api docs can be found here https://articko-artickbot.hf.space/api/v1/docs#/
 
+## Table of Contents
+
+- [Overview](#overview)
+- [Endpoints](#endpoints)
+  - [/thread/{user_id}](#threaduser_id)
+  - [/chat_thread/{user_id}](#chat_threaduser_id)
+
 ## Requirements
 
 - Docker
@@ -34,77 +41,109 @@ All api docs can be found here https://articko-artickbot.hf.space/api/v1/docs#/
 
 ### Accessing the API
 
-You can access the API endpoints using a web browser or an HTTP client at `https://articko-artickbot.hf.space/api/v1/`.
+You can access the API endpoints using a web browser or an HTTP client at `https://articko-artickbot.hf.space/`.
 
-## Endpoints
+Sure, here's a revised version of the README.md file:
 
-### `POST https://articko-artickbot.hf.space/api/v1/chat`
-
-Starts a new conversation thread with a provided user message prompt.
+---
 
-#### Request Body
+## Endpoints
 
-```json
-{
-    "msg_prompt": "User's message prompt"
-}
-```
+### /thread/{user_id}
 
-#### Response
+Starts a new conversation thread with a provided prompt for a specific user. Remember this uses the ai persona written inside the code, for custom ai persona use endpoint /chat_thread/{user_id}
 
-```json
-{
-    "thread_id": id of the conversation,
-    "response": {
-        "user": "User's message prompt",
-        "assistant": "Generated response from the chatbot"
+- **Method**: `POST`
+- **Parameters**:
+  - `user_id` (str): The unique identifier for the user.
+- **Request Body**:
+  ```json
+  {
+    "msg_prompt": "User's message prompt",
+    "msg_history": "Previous chat history (optional)"
+  }
+  ```
+- **Responses**:
+  - `200 OK`: Successfully started a new conversation thread.
+    ```json
+    {
+      "response": {
+        "user_id": "user_id",
+        "thread": {
+          "thread_id": "unique_thread_id",
+          "message_id": "unique_message_id",
+          "message": {
+            "user": "User's message prompt",
+            "assistant": "Model's response"
+          }
+        }
+      }
+    }
+    ```
+  - `400 Bad Request`: If the prompt is not provided.
+    ```json
+    {
+      "detail": "Prompt not provided"
+    }
+    ```
+  - `500 Internal Server Error`: If an unexpected error occurs.
+    ```json
+    {
+      "detail": "Internal Server Error"
     }
-}
-```
+    ```
 
-### `POST https://articko-artickbot.hf.space/api/v1/prompted_chat`
+### /chat_thread/{user_id}
 
 Starts a new chat thread with a provided user message prompt and persona description of the AI assistant.
 
-#### Request Body
-
-```json
-{
+- **Method**: `POST`
+- **Parameters**:
+  - `user_id` (str): The unique identifier for the user.
+- **Request Body**:
+  ```json
+  {
+    "ai_persona": "AI assistant's persona description",
     "msg_prompt": "User's message prompt",
-    "instructions_prompt": "Persona description of the AI assistant. it must be well decsribed with proper grammar and  and isntructions,intensions etc of the assistant for better results"
-}
-```
-
-#### Response
-
-```json
-{
-    "thread_id": "ID of the conversation thread",
-    "response": {
-        "user": "User's message prompt",
-        "assistant": "Generated response from the chatbot"
+    "msg_history": "Previous chat history (optional)"
+  }
+  ```
+- **Responses**:
+  - `200 OK`: Successfully started a new chat thread.
+    ```json
+    {
+      "response": {
+        "user_id": "user_id",
+        "thread": {
+          "thread_id": "unique_thread_id",
+          "message_id": "unique_message_id",
+          "message": {
+            "user": "User's message prompt",
+            "assistant": "Model's response"
+          }
+        }
+      }
     }
-}
-```
-
-### `GET https://articko-artickbot.hf.space/api/v1/get_response/{thread_id}`
-
-Retrieves the response of a conversation thread by its ID.
+    ```
+  - `400 Bad Request`: If the prompt is not provided.
+    ```json
+    {
+      "detail": "Prompt not provided"
+    }
+    ```
+  - `500 Internal Server Error`: If an unexpected error occurs.
+    ```json
+    {
+      "detail": "Internal Server Error"
+    }
+    ```
 
-#### Path Parameters
+This README provides an overview of Articko Bot and detailed information about its endpoints, including request bodies and responses.
 
-- `thread_id`: ID of the conversation thread
+--- 
 
-#### Response
+This should give users a clear understanding of how to interact with the API and what to expect in terms of responses.
 
-```json
-{
-    "response": {
-        "user": "User's message prompt",
-        "assistant": "Generated response from the chatbot"
-    }
-}
-```
 
 For more details on each endpoint, refer to the docstrings within the source code.
 
@@ -116,6 +155,4 @@ Contributions are welcome! If you find any issues or have suggestions for improv
 
 This project is licensed under the [MIT License](LICENSE).
 
----
-
-Feel free to customize this README file further to include additional information specific to your project or environment. If you have any questions or need further assistance, don't hesitate to ask!
+---