KevinHuSh
commited on
Commit
·
a5eac11
1
Parent(s):
153040c
refine docs for chat bot api. (#463)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- README.md +1 -0
- README_ja.md +1 -0
- README_zh.md +1 -0
- docs/conversation_api.md +4 -0
README.md
CHANGED
|
@@ -55,6 +55,7 @@
|
|
| 55 |
|
| 56 |
## 📌 Latest Features
|
| 57 |
|
|
|
|
| 58 |
- 2024-04-16 Add an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding).
|
| 59 |
- 2024-04-16 Add [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
|
| 60 |
- 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
|
|
|
|
| 55 |
|
| 56 |
## 📌 Latest Features
|
| 57 |
|
| 58 |
+
- 2024-04-19 Support chat bot API([detail](./docs/conversation_api.md)).
|
| 59 |
- 2024-04-16 Add an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding).
|
| 60 |
- 2024-04-16 Add [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
|
| 61 |
- 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
|
README_ja.md
CHANGED
|
@@ -55,6 +55,7 @@
|
|
| 55 |
|
| 56 |
## 📌 最新の機能
|
| 57 |
|
|
|
|
| 58 |
- 2024-04-16 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) から埋め込みモデル「bce-embedding-base_v1」を追加します。
|
| 59 |
- 2024-04-16 [FastEmbed](https://github.com/qdrant/fastembed) は、軽量かつ高速な埋め込み用に設計されています。
|
| 60 |
- 2024-04-11 ローカル LLM デプロイメント用に [Xinference](./docs/xinference.md) をサポートします。
|
|
|
|
| 55 |
|
| 56 |
## 📌 最新の機能
|
| 57 |
|
| 58 |
+
- 2024-04-19 チャットボットAPIをサポート([詳細](./docs/conversation_api.md))。
|
| 59 |
- 2024-04-16 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) から埋め込みモデル「bce-embedding-base_v1」を追加します。
|
| 60 |
- 2024-04-16 [FastEmbed](https://github.com/qdrant/fastembed) は、軽量かつ高速な埋め込み用に設計されています。
|
| 61 |
- 2024-04-11 ローカル LLM デプロイメント用に [Xinference](./docs/xinference.md) をサポートします。
|
README_zh.md
CHANGED
|
@@ -55,6 +55,7 @@
|
|
| 55 |
|
| 56 |
## 📌 新增功能
|
| 57 |
|
|
|
|
| 58 |
- 2024-04-16 添加嵌入模型 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) 。
|
| 59 |
- 2024-04-16 添加 [FastEmbed](https://github.com/qdrant/fastembed) 专为轻型和高速嵌入而设计。
|
| 60 |
- 2024-04-11 支持用 [Xinference](./docs/xinference.md) 本地化部署大模型。
|
|
|
|
| 55 |
|
| 56 |
## 📌 新增功能
|
| 57 |
|
| 58 |
+
- 2024-04-19 支持聊天机器人API([更多](./docs/conversation_api.md)).
|
| 59 |
- 2024-04-16 添加嵌入模型 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) 。
|
| 60 |
- 2024-04-16 添加 [FastEmbed](https://github.com/qdrant/fastembed) 专为轻型和高速嵌入而设计。
|
| 61 |
- 2024-04-11 支持用 [Xinference](./docs/xinference.md) 本地化部署大模型。
|
docs/conversation_api.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
| 1 |
# Chat Bot API Instruction
|
| 2 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
## Base URL
|
| 4 |
```buildoutcfg
|
| 5 |
https://demo.ragflow.io/v1/
|
|
|
|
| 1 |
# Chat Bot API Instruction
|
| 2 |
|
| 3 |
+
<div align="center" style="margin-top:20px;margin-bottom:20px;">
|
| 4 |
+
<img src="https://github.com/infiniflow/ragflow/assets/12318111/df0dcc3d-789a-44f7-89f1-7a5f044ab729" width="830"/>
|
| 5 |
+
</div>
|
| 6 |
+
|
| 7 |
## Base URL
|
| 8 |
```buildoutcfg
|
| 9 |
https://demo.ragflow.io/v1/
|