From c7c4dace0280038af52ac9bbd5452e947552793f Mon Sep 17 00:00:00 2001 From: Kense Date: Tue, 23 Jan 2024 17:11:25 +0800 Subject: [PATCH] docs: add message streaming output instructions to readme --- README.md | 24 +++++++++++++----------- README_CN.md | 4 +++- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 814248e..b235218 100644 --- a/README.md +++ b/README.md @@ -40,21 +40,23 @@ assistant = client.beta.assistants.create( ## Why Choose Open Assistant API -| Feature | Open Assistant API | OpenAI Assistant API | -|--------------------|-----------------------|----------------------| -| Ecosystem Strategy | Open Source | Closed Source | -| RAG Engine | Simple Implementation | Supported | -| Internet Search | Supported | Not Supported | -| Custom Functions | Supported | Supported | -| Built-in Tool | Extendable | Not Extendable | -| Code Interpreter | Under Development | Supported | -| LLM Support | Supports More LLMs | Only GPT | -| Local Deployment | Supported | Not Supported | +| Feature | Open Assistant API | OpenAI Assistant API | +|--------------------------|-----------------------|----------------------| +| Ecosystem Strategy | Open Source | Closed Source | +| RAG Engine | Simple Implementation | Supported | +| Internet Search | Supported | Not Supported | +| Custom Functions | Supported | Supported | +| Built-in Tool | Extendable | Not Extendable | +| Code Interpreter | Under Development | Supported | +| LLM Support | Supports More LLMs | Only GPT | +| Message Streaming Output | Supports | Not Supported | +| Local Deployment | Supported | Not Supported | - **LLM Support**: Compared to the official OpenAI version, more models can be supported by integrating with One API. - **Tool**: Currently supports online search; can easily expand more tools. - **RAG Engine**: The currently supported file types are txt, pdf, html, markdown. We provide a preliminary implementation. +- **Message Streaming Output**: Support message streaming output for a smoother user experience. - **Ecosystem Strategy**: Open source, you can deploy the service locally and expand the existing features. ## Quick Start @@ -105,7 +107,7 @@ python tests/e2e/index.py channel to see new releases, discuss issues, and participate in community interactions. - Join the [Discord](https://discord.gg/VfBruz4B) channel to interact with other community members. - Join the WeChat group: - + ![](docs/imgs/wx.png) ## Special Thanks diff --git a/README_CN.md b/README_CN.md index 7f80bd4..0d9d8fe 100644 --- a/README_CN.md +++ b/README_CN.md @@ -48,11 +48,13 @@ assistant = client.beta.assistants.create( | 内置 Tool | 支持扩展 | 不支持扩展 | | Code Interpreter | 待开发 | 支持 | | LLM 支持 | 支持更多的 LLM | 仅 GPT | +| Message 流式输出 | 支持 | 不支持 | | 本地部署 | 支持 | 不支持 | - **LLM 支持**: 相较于 OpenAI 官方版本，可以通过接入 One API 来支持更多的模型。 - **Tool**: 目前支持联网搜索；可以较容易扩展更多的 Tool。 - **RAG 引擎**: 目前支持的文件类型有 txt、pdf、html、markdown。我们提供了一个初步的实现。 +- **Message 流式输出**: 支持 Message 流式输出，提供更流畅的用户体验。 - **生态策略**: 开源，你可以将服务部署在本地，可以对已有功能进行扩展。 ## 快速上手 @@ -101,7 +103,7 @@ python tests/e2e/index.py 频道，查看新发布的内容，交流问题，参与社区互动。 - 加入 [Discord](https://discord.gg/VfBruz4B) 频道，与其他社区成员交流。 - 加入 Open Assistant Api 微信交流群： - + ![](docs/imgs/wx.png) ## 特别感谢