docs: 优化 FAQ 问题分类

This commit is contained in:
WJG 2024-06-11 01:41:52 +08:00
parent b8c646fccb
commit 1ea867f49a
No known key found for this signature in database
GPG Key ID: 258474EF8590014A
2 changed files with 43 additions and 58 deletions

View File

@ -4,29 +4,23 @@
大部分型号的小爱音箱都支持,推荐小爱音箱 Pro完美运行。部分机型的 MioT 接口开放能力并不完整,比如小米音箱 Play 增强版L05C将会导致 `MiGPT` 部分功能异常,相关 [issue](https://github.com/idootop/mi-gpt/issues/14)。
### Q除了 OpenAI 还支持哪些模型,如何设置?
理论上兼容 [OpenAI SDK](https://www.npmjs.com/package/openai) 的模型都支持,只需修改环境变量即可接入到 MiGPT。
比如:[通义千问](https://help.aliyun.com/zh/dashscope/developer-reference/compatibility-of-openai-with-dashscope/?spm=a2c4g.11186623.0.i1)、[零一万物](https://platform.01.ai/docs#making-an-api-request)、[Moonshot](https://platform.moonshot.cn/docs/api/chat)、[DeepSeek](https://platform.deepseek.com/api-docs/) 等,以 Moonshot 为例:
```shell
OPENAI_BASE_URL=https://api.moonshot.cn/v1
OPENAI_MODEL=moonshot-v1-8k
OPENAI_API_KEY=$MOONSHOT_API_KEY
```
### Q什么是唤醒模式
`唤醒模式` 类似于小爱技能,可能让你在跟小爱互动的时候,无需每句话都要以“小爱同学”开头唤醒。
关于唤醒模式的更多细节请查看这里https://github.com/idootop/mi-gpt/issues/28
## ❌ 启动失败类问题
### Q提示登录小米账号失败无法正常启动
1. **账号密码不正确**:小米 ID 并非手机号或邮箱,请在[「个人信息」-「小米 ID」](https://account.xiaomi.com/fe/service/account/profile)查看。
2. **网络环境异常**:如果你是在海外服务器等,非中国大陆网络环境下登录小米账号,需要先同意小米的「个人数据跨境传输」协议,然后按照提示验证手机号或邮箱,等待大约 30 分钟之后即可正常登录。[👉 相关教程](https://github.com/idootop/mi-gpt/issues/22#issuecomment-2150535622)
### Q启动 docker 提示 ERR_MODULE_NOT_FOUND无法正常启动
在 Windows 终端比如PowerShell、cmd无法使用 `$(pwd)` 获取当前工作目录绝对路径,需要填写 `.env``.migpt.js` 文件的绝对路径。示例:
```shell
docker run --env-file D:/hello/mi-gpt/.env -v D:/hello/mi-gpt/.migpt.js:/app/.migpt.js idootop/mi-gpt:latest
```
## 🔊 播放异常类问题
### Q小爱音箱收到消息后没有调用 AI 进行回复
`MiGPT` 收到消息默认不会调用 AI 进行回复,只会回复以唤醒词开头的消息,比如:“请问 xxx”、“你 xxx” 等,你也可以自定义唤醒词(`callAIKeywords`)列表。
@ -58,54 +52,24 @@ OPENAI_API_KEY=$MOONSHOT_API_KEY
</details>
如果修改参数后问题仍然存在,说明你的设备不支持通过开放接口查询播放状态(比如:小米音箱 Play 增强版),## 此问题无解。建议更换其他型号的小爱音箱(推荐小爱音箱 Pro相关 [issue](https://github.com/idootop/mi-gpt/issues/14)。
如果修改参数后问题仍然存在,说明你的设备不支持通过开放接口查询播放状态(比如:小米音箱 Play 增强版),此问题无解。建议更换其他型号的小爱音箱(推荐小爱音箱 Pro相关 [issue](https://github.com/idootop/mi-gpt/issues/14)。
或者你也可以关闭配置文件中的流式响应streamResponse选项确保小爱能够回复完整的句子。不过需要注意的是关闭流式响应后唤醒模式等功能将会失效。
### Q: 为什么小爱音箱会在 AI 回答之前抢话?
## 🤖 大模型类问题
与本项目的实现原理有关。本项目通过轮询小米接口获取最新的对话信息,当检测到小爱在回复的时候会通过播放静音音频等方式快速 mute 掉小爱原来的回复。
### Q除了 OpenAI 还支持哪些模型,如何设置?
但是从小爱开始回复,到上报状态给小米服务云端,再到本项目通过小米云端接口轮训到这个状态变更,中间会有大约 1 -2 秒的延迟时间,无解
理论上兼容 [OpenAI SDK](https://www.npmjs.com/package/openai) 的模型都支持,只需修改环境变量即可接入到 MiGPT
这个问题,理论上需要通过刷机才能完美解决,可以参考下面的相关讨论:
- https://github.com/yihong0618/xiaogpt/issues/515#issuecomment-2121602572
- https://github.com/idootop/mi-gpt/issues/21#issuecomment-2147125219
### Q启动 docker 提示 ERR_MODULE_NOT_FOUND无法正常启动
在 Windows 终端比如PowerShell、cmd无法使用 `$(pwd)` 获取当前工作目录绝对路径,需要填写 `.env``.migpt.js` 文件的绝对路径。相关 [issue](https://github.com/idootop/mi-gpt/issues/26#issuecomment-2151381521)
<details>
<summary>👉 查看示例</summary>
请将下面的 `/绝对路径/` 替换为你当前目录的绝对路径:
比如:[通义千问](https://help.aliyun.com/zh/dashscope/developer-reference/compatibility-of-openai-with-dashscope/?spm=a2c4g.11186623.0.i1)、[零一万物](https://platform.01.ai/docs#making-an-api-request)、[Moonshot](https://platform.moonshot.cn/docs/api/chat)、[DeepSeek](https://platform.deepseek.com/api-docs/) 等,以 Moonshot 为例:
```shell
docker run -d --env-file /绝对路径/.env \
-v /绝对路径/.migpt.js:/app/.migpt.js \
idootop/mi-gpt:latest
OPENAI_BASE_URL=https://api.moonshot.cn/v1
OPENAI_MODEL=moonshot-v1-8k
OPENAI_API_KEY=$MOONSHOT_API_KEY
```
Windows PowerShell 终端
```shell
docker run -d --env-file $pwd\.env `
-v $pwd\.migpt.js:/app/.migpt.js `
idootop/mi-gpt:latest
```
Windows cmd 终端
```shell
docker run -d --env-file %cd%\.env ^
-v %cd%\.migpt.js:/app/.migpt.js ^
idootop/mi-gpt:latest
```
</details>
### Q是否支持 Azure OpenAI如何配置
如果你想使用 [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service),可通过配置以下环境变量开启:
@ -119,9 +83,30 @@ AZURE_OPENAI_DEPLOYMENT=你的模型部署名比如gpt-35-turbo-instruct
注意Azure OpenAI Studio 部署页面显示的模型版本号,可能并非实际的 `OPENAI_API_VERSION` 值。请打开模型 Play Ground 页面,选择你想用的部署(模型),然后点击示例代码,查看里面的 `api_version` 并替换上面的 `OPENAI_API_VERSION` 的值。
## 🚗 运行原理类问题
### Q什么是唤醒模式
`唤醒模式` 类似于小爱技能,可能让你在跟小爱互动的时候,无需每句话都要以“小爱同学”开头唤醒。
关于唤醒模式的更多细节请查看这里https://github.com/idootop/mi-gpt/issues/28
### Q为什么小爱音箱会在 AI 回答之前抢话?
与本项目的实现原理有关。本项目通过轮询小米接口获取最新的对话信息,当检测到小爱在回复的时候会通过播放静音音频等方式快速 mute 掉小爱原来的回复。
但是从小爱开始回复,到上报状态给小米服务云端,再到本项目通过小米云端接口轮训到这个状态变更,中间会有大约 1 -2 秒的延迟时间,无解。
这个问题,理论上需要通过刷机才能完美解决,可以参考下面的相关讨论:
- https://github.com/yihong0618/xiaogpt/issues/515#issuecomment-2121602572
- https://github.com/idootop/mi-gpt/issues/21#issuecomment-2147125219
## ⭐️ 其他问题
### Q怎样使用豆包的音色
此功能需要豆包 TTS 接口支持,本项目暂不对外提供此服务。
此功能需要豆包 TTS 接口支持,本项目暂不对外提供此服务。后续会支持火山引擎 TTS 服务(豆包同款),可以使用演示视频中的熊二等音色。
### Q我还有其他问题

View File

@ -17,14 +17,14 @@
## 📒 文档 FAQ
- 优化关于 Azure OpenAI 配置的说明。https://github.com/idootop/mi-gpt/issues/7
- 优化关于 Azure OpenAI 配置的说明。https://github.com/idootop/mi-gpt/issues/7
- 优化找不到小爱设备的提示文案以及 FAQ 教程。https://github.com/idootop/mi-gpt/issues/28#issuecomment-2153645819
- 添加关于唤醒小爱、唤醒词、唤醒模式的说明和注意事项。
- ✅ 添加关于 clone 项目本地运行的相关配置教程。
- ✅ 添加关于本地构建本项目 docker 镜像的说明。
- 添加关于 playingCommand 的详细说明,默认不需要配置。
- 添加常见小爱音箱型号的支持情况和参数列表。
- 添加关于 clone 项目本地运行提示找不到 bot 的相关说明。
- 添加关于 clone 项目本地运行提示找不到 bot 的相关说明。
- 添加国内设备代理配置相关的说明。https://github.com/idootop/mi-gpt/issues/29
- 添加国内设备使用 Docker 镜像配置镜像代理的说明。https://github.com/idootop/mi-gpt/issues/31
- 添加关于 OpenAI 401 账号 API_KEY 错误, 403 触发 IP 访问风控的说明。https://github.com/idootop/mi-gpt/issues/19https://github.com/idootop/mi-gpt/issues/33