Update README.md
Browse files
README.md
CHANGED
@@ -12,19 +12,25 @@ app_port: 7860
|
|
12 |
Certainly! Here's the content for your README.md file in markdown format:
|
13 |
|
14 |
```markdown
|
|
|
|
|
15 |
# ArtickBot
|
16 |
|
17 |
- 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.
|
18 |
|
|
|
|
|
|
|
|
|
19 |
## Usage
|
20 |
1. Run the FastAPI server:
|
21 |
|
22 |
- The application runs from a Dockerfile where everything is setup for you
|
23 |
|
24 |
-
```
|
25 |
-
|
26 |
2. Open your web browser and go to https://articko-artickbot.hf.space/api/v1/ to access the API documentation provided by FastAPI.
|
27 |
-
|
|
|
|
|
28 |
|
29 |
3.
|
30 |
- `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
|
|
|
12 |
Certainly! Here's the content for your README.md file in markdown format:
|
13 |
|
14 |
```markdown
|
15 |
+
|
16 |
+
```
|
17 |
# ArtickBot
|
18 |
|
19 |
- 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.
|
20 |
|
21 |
+
```
|
22 |
+
|
23 |
+
|
24 |
+
```
|
25 |
## Usage
|
26 |
1. Run the FastAPI server:
|
27 |
|
28 |
- The application runs from a Dockerfile where everything is setup for you
|
29 |
|
|
|
|
|
30 |
2. Open your web browser and go to https://articko-artickbot.hf.space/api/v1/ to access the API documentation provided by FastAPI.
|
31 |
+
|
32 |
+
|
33 |
+
## Use the provided endpoints to interact with the chatbot:
|
34 |
|
35 |
3.
|
36 |
- `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
|