Update README.md

README.md

@@ -38,17 +38,30 @@ Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers li
 ## Usage
 1. Run the FastAPI server:
    ```bash
-   uvicorn main:app --reload
+     - The application runs from a Dockerfile where everything is setup for you
    ```
-   This will start the FastAPI server with automatic reloading enabled for development.
 
-2. Open your web browser and go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) to access the API documentation provided by FastAPI.
-
-3. Use the provided endpoints to interact with the chatbot:
-   - `/start_chat/`: Start a new chat thread by providing a prompt and a contextual prompt.
+2. Open your web browser and go to https://articko-artickbot.hf.space/api/v1/ to access the API documentation provided by FastAPI.
+    - Use the provided endpoints to interact with the chatbot:
+   
+3. 
+   - `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
+   ```json
+      {"prompt":"what food would you recommend",
+      "persona_prompt":"you are a very helpful ai assistant. you are going to be polite and answer a humanily."
+      }
+   ```
+     - This method returns {'thread_id': thread_id, 'response': response}
+   
    - `/start_conversation/`: Start a new conversation thread by providing a prompt.
+  ```json
+    {"prompt":"what is the time"}
+      - After the request is done, this function returns {'response': response}
+  ```
    - `/get_response/{thread_id}`: Retrieve the response from an existing conversation thread using its thread ID.
-   - `/chat/`: Initiate a chat session by providing a prompt.
+     
+       - Returns the specific thread id of the conversation
+         
 
 ## Example
 
@@ -56,7 +69,7 @@ Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers li
 import requests
 
 # Start a new chat session
-response = requests.post("http://127.0.0.1:8000/chat/", json={"prompt": "Hello, how are you?"})
+response = requests.post("https://articko-artickbot.hf.space/api/v1/start_conversation", json={"prompt": "Hello, how are you?"})
 print(response.json())
 ```
 
@@ -65,6 +78,4 @@ print(response.json())
 This README provides an overview of the project, installation instructions, usage guidelines, and an example of how to interact with the chatbot using the provided endpoints. Feel free to customize it further to suit your project's needs.
 ```
 
-You can save this content to a file named `README.md` in your project directory.
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference