Update README.md
Browse files
README.md
CHANGED
@@ -42,7 +42,7 @@ Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers li
|
|
42 |
```
|
43 |
|
44 |
2. Open your web browser and go to https://articko-artickbot.hf.space/api/v1/ to access the API documentation provided by FastAPI.
|
45 |
-
|
46 |
|
47 |
3.
|
48 |
- `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
|
@@ -51,13 +51,14 @@ Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers li
|
|
51 |
"persona_prompt":"you are a very helpful ai assistant. you are going to be polite and answer a humanily."
|
52 |
}
|
53 |
```
|
54 |
-
|
55 |
|
56 |
- `/start_conversation/`: Start a new conversation thread by providing a prompt.
|
57 |
```json
|
58 |
{"prompt":"what is the time"}
|
59 |
-
- After the request is done, this function returns {'response': response}
|
60 |
```
|
|
|
|
|
61 |
- `/get_response/{thread_id}`: Retrieve the response from an existing conversation thread using its thread ID.
|
62 |
|
63 |
- Returns the specific thread id of the conversation
|
|
|
42 |
```
|
43 |
|
44 |
2. Open your web browser and go to https://articko-artickbot.hf.space/api/v1/ to access the API documentation provided by FastAPI.
|
45 |
+
- ` Use the provided endpoints to interact with the chatbot:
|
46 |
|
47 |
3.
|
48 |
- `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
|
|
|
51 |
"persona_prompt":"you are a very helpful ai assistant. you are going to be polite and answer a humanily."
|
52 |
}
|
53 |
```
|
54 |
+
- `This method returns {'thread_id': thread_id, 'response': response}
|
55 |
|
56 |
- `/start_conversation/`: Start a new conversation thread by providing a prompt.
|
57 |
```json
|
58 |
{"prompt":"what is the time"}
|
|
|
59 |
```
|
60 |
+
After the request is done, this function returns {'response': response}
|
61 |
+
|
62 |
- `/get_response/{thread_id}`: Retrieve the response from an existing conversation thread using its thread ID.
|
63 |
|
64 |
- Returns the specific thread id of the conversation
|