From ae4e6229118d4a90b25f242110fda79c8f0b2e38 Mon Sep 17 00:00:00 2001 From: HonestQiao Date: Tue, 11 Feb 2025 23:56:21 +0800 Subject: [PATCH] Update README --- README.md | 29 ++++++++++++++++++++--------- README_en.md | 30 +++++++++++++++++++++--------- 2 files changed, 41 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1fbe5db1..d0d5f634 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ - `xiaozhi-esp32` 通信 WebSocket 协议 - 支持唤醒对话、手动对话、实时打断对话 - 支持国语、粤语、英语、日语、韩语 5 种语言识别（FunASR（默认）） -- 自由更换 LLM（支持ChatGLM（默认）、阿里百炼、Dify、DeepSeek） +- 自由更换 LLM（openai接口支持ChatGLM（默认）、阿里百炼、DeepSeek等，dify接口支持Dify官方及私有化部署） - 自由更换 TTS（支持EdgeTTS（默认）、火山引擎豆包TTS） ## 正在实现 @@ -52,15 +52,17 @@ | 类型 | 平台名称 | 使用方式 | 收费模式 | 备注 | |:----|:----------|:----:|:--------|:----------------------------------------------------------------| -| LLM | 阿里百炼 | 接口调用 | 消耗token | [点击申请密钥](https://bailian.console.aliyun.com/?apiKey=1#/api-key) | -| LLM | 深度求索 | 接口调用 | 消耗token | [点击申请密钥](https://platform.deepseek.com/) | -| LLM | Dify | 接口调用 | 消耗token | 本地化部署 | -| LLM | 智谱 | 接口调用 | 免费 | [点击创建密钥](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) | +| LLM | 阿里百炼 | openai接口调用 | 消耗token | [点击申请密钥](https://bailian.console.aliyun.com/?apiKey=1#/api-key) | +| LLM | 深度求索 | openai接口调用 | 消耗token | [点击申请密钥](https://platform.deepseek.com/) | +| LLM | 智谱 | openai接口调用 | 免费 | [点击创建密钥](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) | +| LLM | Dify | dify接口调用 | 消耗token | 本地化部署 | | TTS | 火山引擎 | 接口调用 | 消耗token | [点击创建密钥](https://console.volcengine.com/speech/service/8) | | TTS | EdgeTTS | 接口调用 | 免费 | | | VAD | SileroVAD | 本地使用 | 免费 | | | ASR | FunASR | 本地使用 | 免费 | | +实际上，任何支持openai接口调用的LLM，都可以接入使用。 + # 部署方式 本项目支持docker快速部署和本地源码运行。如果您主要是想快速体验，推荐使用docker部署。如果想深入了解本项目，推荐本地源码运行。 @@ -102,17 +104,23 @@ selected_module: TTS: EdgeTTS ``` -比如修改`LLM`使用的组件，就看本项目支持哪些`LLM`，如下就是支持`DeepSeekLLM`、`ChatGLMLLM`。你们在`selected_module`修改成对应的LLM +比如修改`LLM`使用的组件，就看本项目支持哪些`LLM` API接口，当前支持的是`openai`、`dify`。欢迎验证和支持更多LLM平台的接口。 + +使用时，在`selected_module`修改成对应的如下LLM配置的名称： ``` LLM: AliLLM: + type: openai ... DeepSeekLLM: + type: openai ... ChatGLMLLM: + type: openai ... DifyLLM: + type: dify ... ``` @@ -214,8 +222,7 @@ pip install -r requirements.txt 目录下。下面两个下载路线任选一个。 - 线路一：阿里魔塔下载[SenseVoiceSmall](https://modelscope.cn/models/iic/SenseVoiceSmall/resolve/master/model.pt) -- 线路二：百度网盘下载[SenseVoiceSmall](https://pan.baidu.com/share/init?surl=QlgM58FHhYv1tFnUT_A8Sg&pwd=qvna) 提取码: - `qvna` +- 线路二：百度网盘下载[SenseVoiceSmall](https://pan.baidu.com/share/init?surl=QlgM58FHhYv1tFnUT_A8Sg&pwd=qvna) 提取码: `qvna` ### 4.配置项目 @@ -234,15 +241,19 @@ selected_module: TTS: EdgeTTS ``` -比如修改`LLM`使用的组件，就看本项目支持哪些`LLM`，如下就是支持`DeepSeekLLM`、`ChatGLMLLM`。你们在`selected_module`修改成对应的LLM +比如修改`LLM`使用的组件，就看本项目支持哪些`LLM` API接口，当前支持的是`openai`、`dify`。欢迎验证和支持更多LLM平台的接口。 +使用时，在`selected_module`修改成对应的如下LLM配置的名称： ``` LLM: DeepSeekLLM: + type: openai ... ChatGLMLLM: + type: openai ... DifyLLM: + type: dify ... ``` diff --git a/README_en.md b/README_en.md index 8d038e58..abf42356 100644 --- a/README_en.md +++ b/README_en.md @@ -44,7 +44,7 @@ use it in the production environment. - `xiaozhi-esp32` WebSocket communication protocol - Supports wake-word initiated dialogue, manual dialogue, and real-time interruption of dialogue. - Support for 5 languages: Mandarin, Cantonese, English, Japanese, Korean (FunASR - default) -- Flexible LLM switching (ChatGLM - default, Aliyun, Dify, DeepSeek) +- Flexible LLM switching (openai:ChatGLM - default, Aliyun, DeepSeek; dify:Dify) - Flexible TTS switching (EdgeTTS - default, ByteDance Doubao TTS) ## In Progress @@ -57,15 +57,17 @@ use it in the production environment. | Type | Service | Usage | Pricing Model | Notes | |:-----|:-----------|:--------:|:---------------|:---------------------------------------------------------------------------| -| LLM | Aliyun | API call | Token-based | [Apply for API Key](https://bailian.console.aliyun.com/?apiKey=1#/api-key) | -| LLM | DeepSeek | API call | Token-based | [Apply for API Key](https://platform.deepseek.com/) | -| LLM | Dify | API call | Token-based | Self-hosted | -| LLM | Bigmodel | API call | Free | [Create API Key](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) | +| LLM | Aliyun | openai API call | Token-based | [Apply for API Key](https://bailian.console.aliyun.com/?apiKey=1#/api-key) | +| LLM | DeepSeek | openai API call | Token-based | [Apply for API Key](https://platform.deepseek.com/) | +| LLM | Bigmodel | openai API call | Free | [Create API Key](https://bigmodel.cn/usercenter/proj-mgmt/apikeys) | +| LLM | Dify | dify API call | Token-based | Self-hosted | | TTS | HuoshanTTS | API call | Token-based | [Create API Key](https://console.volcengine.com/speech/service/8) | | TTS | EdgeTTS | API call | Free | | | VAD | SileroVAD | Local | Free | | | ASR | FunASR | Local | Free | | +In fact, any LLM that supports OpenAI API calls can be integrated and used. + # Deployment This project supports rapid deployment of docker and local source code operation. If you want to have a quick @@ -117,18 +119,22 @@ selected_module: TTS: EdgeTTS ``` -For example, modify the components used by `llm`, depending on which` llm` supports this project, as follows, it -supports `Deepseekllm` and` Chatglmllm`. You are modified to the corresponding LLM in `selectd_module` +For example, to modify the components used by the `LLM`, it depends on which `LLM` API interfaces are supported by this project. Currently, the supported ones are `openai` and `dify`. We welcome validation and support for more LLM platforms' interfaces. +When using it, change the `selected_module` to the corresponding name of the following LLM configurations: ``` LLM: AliLLM: + type: openai ... DeepSeekLLM: + type: openai ... ChatGLMLLM: + type: openai ... DifyLLM: + type: openai ... ``` @@ -254,16 +260,22 @@ selected_module: TTS: EdgeTTS ``` -For example, modify the components used by `llm`, depending on which` llm` supports this project, as follows, it -supports `Deepseekllm` and` Chatglmllm`. You are modified to the corresponding LLM in `selectd_module` +For example, to modify the components used by the `LLM`, it depends on which `LLM` API interfaces are supported by this project. Currently, the supported ones are `openai` and `dify`. We welcome validation and support for more LLM platforms' interfaces. +When using it, change the `selected_module` to the corresponding name of the following LLM configurations: ``` LLM: + AliLLM: + type: openai + ... DeepSeekLLM: + type: openai ... ChatGLMLLM: + type: openai ... DifyLLM: + type: openai ... ```