upstream/mi-gpt

Fork 0

mirror of https://github.com/idootop/mi-gpt.git synced 2024-09-20 14:56:14 +00:00

WJG 76950eb3d9

docs: update readme

2024-02-29 23:24:18 +08:00

9.1 KiB

Raw Blame History

MiGPT：智能家居，从未如此贴心 ❤️

在这个数字化的世界里，家已不仅仅是一个居住的地方，而是我们数字生活的延伸。

MiGPT 通过将小爱音箱、米家智能设备，与 ChatGPT 的理解能力完美融合，让你的智能家居更懂你。

MiGPT 不仅仅是关于设备自动化，而是关于：打造一个懂你、有温度、与你共同进化的家。

✨ 项目亮点

LLM 回答。让小爱音箱使用 ChatGPT 等大模型回答消息，更懂你。
角色扮演。为你的小爱音箱赋予人格，秒变你的魅力女友 or 知心闺蜜。
IoT Agent。自动控制米家设备，比如你说心情不好时，会自动帮你播放轻松舒缓的音乐，调节灯光变柔和等（TODO）
流式响应。秒回消息，爱你，不会让你等太久。
自定义 TTS。厌倦了小爱同学的语音？帮你解锁「豆包」同款音色。

⚡️ 使用教程

无论你是电脑小白还是编程高手，都可以轻松拥有自己的专属 MiGPT。

首先，参考下面的「配置参数」章节，配置好你的 MiGPT 启动参数。

🚀 启动项目

MiGPT 有两种启动方式: Docker 和 NPM。

📦 Docker

对于电脑小白或者不想自己配置代码运行环境（Node）的同学，请参考 Docker 启动方式。

# 请先按照「配置参数」章节，配置好你的 `.env` 和 `.migpt.js` 文件
docker run -d  --env-file $(pwd)/.env \
    -v $(pwd)/.migpt.js:/usr/src/app/.migpt.js \
    idootop/mi-gpt:1.0.0

⭐️ NPM

如果你是一名前端 (Node) 开发者，也可以通过安装 NPM 安装 mi-gpt 包的方式，使用代码启动 MiGPT。

npm install mi-gpt # 安装依赖

然后，创建并启动 MiGPT 实例。初始化参数说明，请看下面的配置参数。

import { MiGPT } from "mi-gpt";

async function main() {
  const client = MiGPT.create({
    speaker: {
      userId: process.env.MI_USER,
      password: process.env.MI_PASS,
      did: process.env.MI_DID,
    },
  });
  await client.start();
}

main();

⚙️ 配置参数

📖 环境变量

重命名本项目根目录下的 .env.example 文件为 .env。

然后，将里面的环境变量修改成你自己的，参数含义如下：

环境变量名称	描述	示例
小米服务
`MI_USER`	小米账户	`"12345678901"`
`MI_PASS`	账户密码	`"123456"`
`MI_DID`	小爱音箱 ID 或名称	`"小爱音箱 Pro"`
OpenAI
`OPENAI_MODEL`	使用的 OpenAI 模型	`gpt-3.5-turbo-0125`
`OPENAI_API_KEY`	OpenAI 的 API 密钥	`sk-xxxxxxxxxxxxxxx`
响应音效（可选）
`AUDIO_SILENT`	静音音频链接	`"https://example.com/slient.wav"`
`AUDIO_BEEP`	默认提示音链接	`"https://example.com/beep.wav"`
`AUDIO_ACTIVE`	唤醒提示音链接	`"https://example.com/active.wav"`
`AUDIO_ERROR`	出错提示音链接	`"https://example.com/error.wav"`
豆包 TTS（可选）
`TTS_DOUBAO`	豆包 TTS 接口	`"https://example.com/tts.wav"`
`SPEAKERS_DOUBAO`	豆包 TTS 音色列表接口	`"https://example.com/tts-speakers"`

🚗 .migpt.js

重命名本项目根目录下的 .migpt.js.example 文件为 .migpt.js。

然后，将里面的配置参数修改成你自己的，参数含义如下：

参数名称	描述	示例
bot
`name`	对方名称（小爱音箱）	`"傻妞"`
`profile`	对方的个人简介/人设	`"性别女，性格乖巧可爱，喜欢搞怪，爱吃醋。"`
master
`name`	主人名称（我自己）	`"陆小千"`
`profile`	主人的个人简介/人设	`"性别男，善良正直，总是舍己为人，是傻妞的主人。"`
room
`name`	会话群名称	`"魔幻手机"`
`description`	会话群简介	`"傻妞和陆小千的私聊"`
speaker
`userId`	小米账户	`"12345678901"`
`password`	账户密码	`"123456"`
`did`	小爱音箱 ID 或名称	`"小爱音箱 Pro"`
其他（可选）
`callAIPrefix`	当消息以召唤关键词开头时，会调用 AI 来响应用户消息	`["请","傻妞"]`
`wakeUpKeyWords`	当消息中包含唤醒关键词时，会进入 AI 唤醒状态	`["召唤傻妞","打开傻妞"]`
`exitKeywords`	当消息中包含退出关键词时，会退出 AI 唤醒状态	`["退出傻妞","关闭傻妞"]`
`onEnterAI`	进入 AI 模式的欢迎语	`["你好，我是傻妞，请问有什么能够帮你的吗？"]`
`onExitAI`	退出 AI 模式的提示语	`["傻妞已退出"]`
`onAIAsking`	AI 开始回答时的提示语	`["请稍等，让我想想"]`
`onAIError`	AI 回答异常时的提示语	`["出错了，请稍后再试吧！"]`
`exitKeepAliveAfter`	无响应一段时间后，多久自动退出唤醒模式（单位秒，默认 30 秒）	`30`

💬 常见问题

Q：怎样使用豆包的语音？

很遗憾，豆包语音需要豆包 TTS 接口支持，本项目暂不对外提供此服务。

Q：我想更换小爱同学的语音，在哪里配置？

其他未声明的配置参数与使用方法，请自行查阅源代码。

Q：我还有其他问题想问，怎么联系你？

请提交 issue

Q：这个项目太棒了，为你点赞 👍

Enjoy it！

🚨 免责声明

本项目旨在分享学习大型语言模型（LLM）智能对话及智能家居自动化相关知识，严禁用于任何商业目的或违反所在地区的法律法规。使用者须知悉，本项目代码可能存在未知的缺陷或风险，因使用本项目引起的任何形式的损失或损害（包括但不限于设备故障、账户被禁等），使用者需自行承担全部责任。

9.1 KiB Raw Blame History Unescape Escape