Update README.md

README.md

@@ -8,49 +8,111 @@ pinned: false
 license: mit
 app_port: 7860
 ---
+---
+
+# ArtickoBOt
+
+This project implements a chatbot using FastAPI and a pre-trained language model. The chatbot can generate responses based on user prompts and persona descriptions.
+
+## Requirements
+
+- Docker
+- Hugging Face Spaces
 
-# ArtickBot
-  - AI chatbot built using FastAPI and Hugging Face's transformers library. It allows users to initiate conversations with the bot and receive responses based on predefined persona templates.
 ## Usage
-1. Run the FastAPI server:
-
-  - The application runs from a Dockerfile where everything is setup for you
-
-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
-       - Expects a POST Request with a JSON Body
-          
-      ```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.
-      - Expects a POST Request with a JSON Body
-      ```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.
-      - Expects a GET Request with the {thread id} of the conversation
-     
-      - `Returns the specific thread id of the conversation
-         
-## Example
-
-```python
-import requests
-
-# Start a new chat session
-response = requests.post("https://articko-artickbot.hf.space/api/v1/start_conversation", json={"prompt": "Hello, how are you?"})
-print(response.json())
+
+### Building the Docker Image
+
+- The application has a Dockerfile that will run automatic and install as well as build the dependencies 
+
+### Running the Docker Container
+
+- The Dockerfile is configured to start uvicorn servers at port: 7860
+- The uvicorn can be configured to use multiple workers to process/serve data
+
+### 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/`.
+
+## Endpoints
+
+### `POST https://articko-artickbot.hf.space/api/v1/chat`
+
+Starts a new conversation thread with a provided user message prompt.
+
+#### Request Body
+
+```json
+{
+    "msg_prompt": "User's message prompt"
+}
+```
+
+#### Response
+
+```json
+{
+    "response": {
+        "user": "User's message prompt",
+        "assistant": "Generated response from the chatbot"
+    }
+}
+```
+
+### `POST https://articko-artickbot.hf.space/api/v1/prompted_chat`
+
+Starts a new chat thread with a provided user message prompt and persona description of the AI assistant.
+
+#### Request Body
+
+```json
+{
+    "msg_prompt": "User's message prompt",
+    "persona_desc": "Persona description of the AI assistant"
+}
+```
+
+#### Response
+
+```json
+{
+    "thread_id": "ID of the conversation thread",
+    "response": {
+        "user": "User's message prompt",
+        "assistant": "Generated response from the chatbot"
+    }
+}
+```
+
+### `GET https://articko-artickbot.hf.space/api/v1/get_response/{thread_id}`
+
+Retrieves the response of a conversation thread by its ID.
+
+#### Path Parameters
+
+- `thread_id`: ID of the conversation thread
+
+#### Response
+
+```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.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
 ---
 
-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.
+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!