Update README

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