Skip to content

Commit 8d96488

Browse files
committed
docs: update docs
1 parent eb0d075 commit 8d96488

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

docs/src/content/chat-engine.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ After logging in with an admin account, you can configure the Chat Engine in the
99
1. Click on the `Chat Engines` tab;
1010
2. Click on the `New Chat Engine` button to create a new chat engine;
1111

12-
!["Chat Engine Creation Page - Basic Information Section"](https://github.com/user-attachments/assets/981a0adc-eac2-484d-8141-7d62c394fd0f )
12+
!["Chat Engine Creation Page - Basic Information Section"](https://github.com/user-attachments/assets/2b7695b8-ce4f-43dd-b19c-fbccb84cebe2)
1313

1414
3. In the `Retrieval` section, you can configure [knowledge base](./knowledge-base.mdx) as the knowledge source and related retrieval parameters.
1515

16-
!["Chat Engine Configuration Page - Retrieval Section"](https://github.com/user-attachments/assets/ed3f3320-a623-4ebb-a10e-d3bee264f20f)
16+
!["Chat Engine Configuration Page - Retrieval Section"](https://github.com/user-attachments/assets/5592deeb-f4f1-4ad9-bc7e-a9eb82a88744)
1717

1818

1919
4. You can also change the prompt to customize the chat experience for your users. The prompt is the message that the chatbot sends to the user to start the conversation.
2020

21-
!["Chat Engine Configuration Page - Prompt Section"](https://github.com/user-attachments/assets/21efccf0-093b-4243-87c8-159ef5975e3c)
21+
!["Chat Engine Configuration Page - Prompt Section"](https://github.com/user-attachments/assets/a5cd25a5-5ec0-4383-b579-dc57b2d6e9f9)
2222

2323
5. Click the `Create Chat Engine` button to finish the configuration.
2424

docs/src/content/knowledge-base.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ After logging in with an admin account, you can configure the Knowledge Base in
3030

3131
5. Go to `Chat Engine` configuration page, select the knowledge base you created and click `Save` to enable it.
3232

33-
![Chat Engine Configuration](https://github.com/user-attachments/assets/2572dc02-ce77-4d2f-a4ba-68bc6858d44c)
33+
![Chat Engine Configuration](https://github.com/user-attachments/assets/5592deeb-f4f1-4ad9-bc7e-a9eb82a88744)
3434

3535

3636
## Data Source Management
@@ -76,7 +76,7 @@ You can delete data source by click the **Delete** button of data source.
7676

7777
You can manage documents in the **Documents** tab.
7878

79-
![Documents Page](https://github.com/user-attachments/assets/878d2809-97a6-4a87-8d3a-3481f8bb863b)
79+
![Documents Page](https://github.com/user-attachments/assets/832959a4-f670-455d-b765-cae4a569e653)
8080

8181
#### Delete Documents
8282

docs/src/content/llm.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,18 @@ To learn more about Vertex AI, please visit [Vertex AI](https://cloud.google.com
5252

5353
Follow the UI to configure the Gitee AI provider. To learn more about Gitee AI, please visit [Gitee AI](https://ai.gitee.com/serverless-api).
5454

55+
#### Ollama
56+
57+
Default config:
58+
59+
```json
60+
{
61+
"api_base": "http://localhost:11434"
62+
}
63+
```
64+
65+
To learn more about Ollama, please visit [Ollama](https://ollama.com/).
66+
5567
### OpenAI
5668

5769
To learn more about OpenAI, please visit [OpenAI](https://platform.openai.com/).
@@ -95,17 +107,6 @@ Default config:
95107
To learn more about BigModel, please visit [BigModel](https://open.bigmodel.cn/).
96108
*/}
97109

98-
#### Ollama
99-
100-
Default config:
101-
102-
```json
103-
{
104-
"api_base": "http://localhost:11434"
105-
}
106-
```
107-
108-
To learn more about Ollama, please visit [Ollama](https://ollama.com/).
109110

110111
#### vLLM
111112

docs/src/content/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Go to the **Chat Engines** page to [set up the chat engine](./chat-engine).
5959

6060
> The chat engine is used to chat with users.
6161
62-
![Set up Chat Engine](https://github.com/user-attachments/assets/2572dc02-ce77-4d2f-a4ba-68bc6858d44c)
62+
![Set up Chat Engine](https://github.com/user-attachments/assets/5592deeb-f4f1-4ad9-bc7e-a9eb82a88744)
6363

6464

6565
## Step 5: Usage

docs/src/content/releases/v0.5.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Release Notes for v0.5.0
1+
# Release Notes for v0.5.0 (Candidate Release)
22

33
## Highlights
44

0 commit comments

Comments
 (0)