From 7da3f88e54ecbca2495bd4b663983f5d0a63dedd Mon Sep 17 00:00:00 2001 From: KevinHuSh <kevinhu.sh@gmail.com> Date: Fri, 19 Apr 2024 19:05:15 +0800 Subject: [PATCH] refine docs for chat bot api. (#463) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- README.md | 1 + README_ja.md | 1 + README_zh.md | 1 + docs/conversation_api.md | 4 ++++ 4 files changed, 7 insertions(+) diff --git a/README.md b/README.md index 2f2c665..cb9298d 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,7 @@ ## đź“Ś Latest Features +- 2024-04-19 Support chat bot API([detail](./docs/conversation_api.md)). - 2024-04-16 Add an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding). - 2024-04-16 Add [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding. - 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment. diff --git a/README_ja.md b/README_ja.md index 61135dc..f9a82b3 100644 --- a/README_ja.md +++ b/README_ja.md @@ -55,6 +55,7 @@ ## đź“Ś 最新ă®ć©źč˝ +- 2024-04-19 ăăŁăăăśăăAPIをサăťăĽă([č©łç´°](./docs/conversation_api.md))。 - 2024-04-16 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) ă‹ă‚‰ĺź‹ă‚込ăżă˘ă‡ă«ă€Śbce-embedding-base_v1ă€Ťă‚’čż˝ĺŠ ă—ăľă™ă€‚ - 2024-04-16 [FastEmbed](https://github.com/qdrant/fastembed) ăŻă€č»˝é‡Źă‹ă¤é«é€źăŞĺź‹ă‚込ăżç”¨ă«č¨č¨ă•ă‚Śă¦ă„ăľă™ă€‚ - 2024-04-11 ăăĽă‚«ă« LLM ă‡ă—ăイăˇăłă用㫠[Xinference](./docs/xinference.md) をサăťăĽăă—ăľă™ă€‚ diff --git a/README_zh.md b/README_zh.md index 000e194..be51272 100644 --- a/README_zh.md +++ b/README_zh.md @@ -55,6 +55,7 @@ ## đź“Ś ć–°ĺ˘žĺŠźč˝ +- 2024-04-19 支ćŚčŠĺ¤©ćśşĺ™¨äşşAPI([更多](./docs/conversation_api.md)). - 2024-04-16 ć·»ĺŠ ĺµŚĺ…Ąć¨ˇĺž‹ [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) 。 - 2024-04-16 ć·»ĺŠ [FastEmbed](https://github.com/qdrant/fastembed) 专为轻型和é«é€źĺµŚĺ…Ąč€Śč®ľč®ˇă€‚ - 2024-04-11 支ćŚç”¨ [Xinference](./docs/xinference.md) 本地化é¨ç˝˛ĺ¤§ć¨ˇĺž‹ă€‚ diff --git a/docs/conversation_api.md b/docs/conversation_api.md index b1c62b2..1ee6bb1 100644 --- a/docs/conversation_api.md +++ b/docs/conversation_api.md @@ -1,5 +1,9 @@ # Chat Bot API Instruction +<div align="center" style="margin-top:20px;margin-bottom:20px;"> +<img src="https://github.com/infiniflow/ragflow/assets/12318111/df0dcc3d-789a-44f7-89f1-7a5f044ab729" width="830"/> +</div> + ## Base URL ```buildoutcfg https://demo.ragflow.io/v1/ -- GitLab