Play ChatGPT or other LLM with xiaomi AI speaker
Project description
xiaogpt
Play ChatGPT and other LLM with Xiaomi AI Speaker
支持的 AI 类型
Windows 获取小米音响DID
pip install miservice_forkset MI_USER=xxxxset MI_PASS=xxxmicli list得到didset MI_DID=xxxx
- 如果获取did报错时，请更换一下无线网络，有很大概率解决问题。
一点原理
准备
- ChatGPT id
- 小爱音响
- 能正常联网的环境或 proxy
- python3.8+
使用
pip install -U --force-reinstall xiaogpt- 参考我 fork 的 MiService 项目 README 并在本地 terminal 跑
micli list拿到你音响的 DID 成功 别忘了设置 export MI_DID=xxx 这个 MI_DID 用 - run
xiaogpt --hardware ${your_hardware} --use_chatgpt_apihardware 你看小爱屁股上有型号，输入进来，如果在屁股上找不到或者型号不对，可以用micli mina找到型号 - 跑起来之后就可以问小爱同学问题了，“帮我"开头的问题，会发送一份给 ChatGPT 然后小爱同学用 tts 回答
- 如果上面不可用，可以尝试用手机抓包，https://userprofile.mina.mi.com/device_profile/v2/conversation 找到 cookie 利用
--cookie '${cookie}'cookie 别忘了用单引号包裹 - 默认用目前 ubus, 如果你的设备不支持 ubus 可以使用
--use_command来使用 command 来 tts - 使用
--mute_xiaoai选项，可以快速停掉小爱的回答 - 使用
--account ${account} --password ${password} - 如果有能力可以自行替换唤醒词，也可以去掉唤醒词
- 使用
--use_chatgpt_api的 api 那样可以更流畅的对话，速度特别快，达到了对话的体验, openai api, 命令--use_chatgpt_api - 使用 gpt-3 的 api 那样可以更流畅的对话，速度快, 请 google 如何用 openai api 命令 --use_gpt3
- 如果你遇到了墙需要用 Cloudflare Workers 替换 api_base 请使用
--api_base ${url}来替换。 请注意，此处你输入的api应该是'https://xxxx/v1'的字样，域名需要用引号包裹 - 可以跟小爱说
开始持续对话自动进入持续对话状态，结束持续对话结束持续对话状态。 - 可以使用
--tts edge来获取更好的 tts 能力 - 可以使用
--tts openai来获取 openai tts 能力 - 可以使用
--use_langchain替代--use_chatgpt_api来调用 LangChain（默认 chatgpt）服务，实现上网检索、数学运算..
e.g.
export OPENAI_API_KEY=${your_api_key}
xiaogpt --hardware LX06 --use_chatgpt_api
# or
xiaogpt --hardware LX06 --cookie ${cookie} --use_chatgpt_api
# 如果你想直接输入账号密码
xiaogpt --hardware LX06 --account ${your_xiaomi_account} --password ${your_password} --use_chatgpt_api
# 如果你想 mute 小米的回答
xiaogpt --hardware LX06 --mute_xiaoai --use_chatgpt_api
# 使用流式响应，获得更快的响应
xiaogpt --hardware LX06 --mute_xiaoai --stream
# 如果你想使用 gpt3 ai
export OPENAI_API_KEY=${your_api_key}
xiaogpt --hardware LX06 --mute_xiaoai --use_gpt3
# 如果你想使用 google 的 gemini
xiaogpt --hardware LX06 --mute_xiaoai --use_gemini --gemini_key ${gemini_key}
# 如果你想使用阿里的通义千问
xiaogpt --hardware LX06 --mute_xiaoai --use_qwen --qen_key ${qwen_key}
# 如果你想用 edge-tts
xiaogpt --hardware LX06 --cookie ${cookie} --use_chatgpt_api --tts edge
# 如果你想使用 LangChain + SerpApi 实现上网检索或其他本地服务（目前仅支持 stream 模式）
export OPENAI_API_KEY=${your_api_key}
export SERPAPI_API_KEY=${your_serpapi_key}
xiaogpt --hardware Lx06 --use_langchain --mute_xiaoai --stream --openai_key ${your_api_key} --serpapi_api_key ${your_serpapi_key}
使用 git clone 运行
export OPENAI_API_KEY=${your_api_key}
python3 xiaogpt.py --hardware LX06
# or
python3 xiaogpt.py --hardware LX06 --cookie ${cookie}
# 如果你想直接输入账号密码
python3 xiaogpt.py --hardware LX06 --account ${your_xiaomi_account} --password ${your_password} --use_chatgpt_api
# 如果你想 mute 小米的回答
python3 xiaogpt.py --hardware LX06 --mute_xiaoai
# 使用流式响应，获得更快的响应
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --stream
# 如果你想使用 gpt3 ai
export OPENAI_API_KEY=${your_api_key}
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --use_gpt3
# 如果你想使用 ChatGLM api
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --use_glm --glm_key ${glm_key}
# 如果你想使用 google 的 bard
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --use_bard --bard_token ${bard_token}
# 如果你想使用 google 的 gemini
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --use_gemini --gemini_key ${gemini_key}
# 如果你想使用阿里的通义千问
python3 xiaogpt.py --hardware LX06 --mute_xiaoai --use_qwen --qen_key ${qwen_key}
# 如果你想使用 LangChain+SerpApi 实现上网检索或其他本地服务（目前仅支持 stream 模式）
export OPENAI_API_KEY=${your_api_key}
export SERPAPI_API_KEY=${your_serpapi_key}
python3 xiaogpt.py --hardware Lx06 --use_langchain --mute_xiaoai --stream --openai_key ${your_api_key} --serpapi_api_key ${your_serpapi_key}
config.json
如果想通过单一配置文件启动也是可以的, 可以通过 --config 参数指定配置文件, config 文件必须是合法的 JSON 格式
参数优先级
- cli args > default > config
python3 xiaogpt.py --config xiao_config.json
# or
xiaogpt --config xiao_config.json
或者
cp xiao_config.json.example xiao_config.json
python3 xiaogpt.py
若要指定 OpenAI 的模型参数，如 model, temporature, top_p, 请在config.json中指定：
{
...
"gpt_options": {
"temperature": 0.9,
"top_p": 0.9,
}
}
具体参数作用请参考 Open AI API 文档。 ChatGLM 文档 Bard-API 参考
配置项说明
| 参数 | 说明 | 默认值 | 可选值 |
|---|---|---|---|
| hardware | 设备型号 | ||
| account | 小爱账户 | ||
| password | 小爱账户密码 | ||
| openai_key | openai的apikey | ||
| serpapi_api_key | serpapi的key 参考 SerpAPI | ||
| glm_key | chatglm 的 apikey | ||
| gemini_key | gemini 的 apikey 参考 | ||
| qwen_key | qwen 的 apikey 参考 | ||
| bard_token | bard 的 token 参考 Bard-API | ||
| cookie | 小爱账户cookie （如果用上面密码登录可以不填） | ||
| mi_did | 设备did | ||
| use_command | 使用 MI command 与小爱交互 | false |
|
| mute_xiaoai | 快速停掉小爱自己的回答 | true |
|
| verbose | 是否打印详细日志 | false |
|
| bot | 使用的 bot 类型，目前支持gpt3,chatgptapi和newbing | chatgptapi |
|
| tts | 使用的 TTS 类型 | mi |
edge、 openai |
| tts_voice | TTS 的嗓音 | zh-CN-XiaoxiaoNeural(edge), alloy(openai) |
|
| prompt | 自定义prompt | 请用100字以内回答 |
|
| keyword | 自定义请求词列表 | ["请"] |
|
| change_prompt_keyword | 更改提示词触发列表 | ["更改提示词"] |
|
| start_conversation | 开始持续对话关键词 | 开始持续对话 |
|
| end_conversation | 结束持续对话关键词 | 结束持续对话 |
|
| stream | 使用流式响应，获得更快的响应 | false |
|
| proxy | 支持 HTTP 代理，传入 http proxy URL | "" | |
| gpt_options | OpenAI API 的参数字典 | {} |
|
| bing_cookie_path | NewBing使用的cookie路径，参考这里获取 | 也可通过环境变量 COOKIE_FILE 设置 |
|
| bing_cookies | NewBing使用的cookie字典，参考这里获取 | ||
| deployment_id | Azure OpenAI 服务的 deployment ID | 参考这个如何找到deployment_id | |
| api_base | 如果需要替换默认的api,或者使用Azure OpenAI 服务 | 例如：https://abc-def.openai.azure.com/ |
注意
- 请开启小爱同学的蓝牙
- 如果要更改提示词和 PROMPT 在代码最上面自行更改
- 目前已知 LX04、X10A 和 L05B L05C 可能需要使用
--use_command，否则可能会出现终端能输出GPT的回复但小爱同学不回答GPT的情况。这几个型号也只支持小爱原本的 tts. - 在wsl使用时, 需要设置代理为 http://wls的ip:port(vpn的代理端口), 否则会出现连接超时的情况, 详情 报错： Error communicating with OpenAI
QA
- 用破解么？不用
- 你做这玩意也没用啊？确实。。。但是挺好玩的，有用对你来说没用，对我们来说不一定呀
- 想把它变得更好？PR Issue always welcome.
- 还有问题？提 Issue 哈哈
- Exception: Error https://api2.mina.mi.com/admin/v2/device_list?master=0&requestId=app_ios_xxx: Login failed @KJZH001
这是由于小米风控导致，海外地区无法登录大陆的账户，请尝试cookie登录 无法抓包的可以在本地部署完毕项目后再用户文件夹C:\Users\用户名下面找到.mi.token，然后扔到你无法登录的服务器去
若是linux则请放到当前用户的home文件夹，此时你可以重新执行先前的命令，不出意外即可正常登录（但cookie可能会过一段时间失效，需要重新获取）
详情请见 https://github.com/yihong0618/xiaogpt/issues/332
视频教程
https://www.youtube.com/watch?v=K4YA8YwzOOA
Docker
常规用法
X86/ARM Docker Image: yihong0618/xiaogpt
docker run -e OPENAI_API_KEY=<your-openapi-key> yihong0618/xiaogpt <命令行参数>
如
docker run -e OPENAI_API_KEY=<your-openapi-key> yihong0618/xiaogpt --account=<your-xiaomi-account> --password=<your-xiaomi-password> --hardware=<your-xiaomi-hardware> --use_chatgpt_api
使用配置文件
xiaogpt的配置文件可通过指定volume /config，以及指定参数--config来处理，如
docker run -v <your-config-dir>:/config yihong0618/xiaogpt --config=/config/config.json
本地编译Docker Image
docker build -t xiaogpt .
如果在安装依赖时构建失败或安装缓慢时，可以在构建 Docker 镜像时使用 --build-arg 参数来指定国内源地址：
docker build --build-arg PIP_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple -t xiaogpt .
如果需要在Apple M1/M2上编译x86
docker buildx build --platform=linux/amd64 -t xiaogpt-x86 .
第三方 TTS
我们目前支持两种第三方 TTS：edge/openai
edge-tts 提供了类似微软tts的能力
Usage
你可以通过参数 tts, 来启用它
{
"tts": "edge",
"tts_voice": "zh-CN-XiaoxiaoNeural"
}
查看更多语言支持, 从中选择一个
edge-tts --list-voices
在容器中使用edge-tts
由于 Edge TTS 启动了一个本地的 HTTP 服务，所以需要将容器的端口映射到宿主机上，并且指定本地机器的 hostname:
docker run -v <your-config-dir>:/config -p 9527:9527 -e XIAOGPT_HOSTNAME=<your ip> yihong0618/xiaogpt --config=/config/config.json
注意端口必须映射为与容器内一致，XIAOGPT_HOSTNAME 需要设置为宿主机的 IP 地址，否则小爱无法正常播放语音。
推荐的 fork
- XiaoBot -> Go语言版本的Fork, 带支持不同平台的UI
感谢
赞赏
谢谢就够了
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xiaogpt-2.21.tar.gz
(32.2 kB
view hashes)
Built Distribution
xiaogpt-2.21-py3-none-any.whl
(35.9 kB
view hashes)
