Skip to content

Commit

Permalink
chore: 默认模型更新为 gpt-4o
Browse files Browse the repository at this point in the history
  • Loading branch information
idootop committed May 21, 2024
1 parent b6f8946 commit df52901
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 36 deletions.
24 changes: 12 additions & 12 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Mi Services
MI_USER="Xiaomi Account"
MI_PASS="Account Password"
MI_DID="Device ID or Name (optional - fill in after retrieving from the device list)"
MI_USER="小米账号"
MI_PASS="账号密码"
MI_DID="小爱音箱设备 ID 或在米家 APP 种设置的设备名称"

# OpenAI
OPENAI_MODEL=gpt-3.5-turbo-0125
OPENAI_MODEL=gpt-4o
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxx

# Sound Effects
AUDIO_SILENT=静音音频链接
AUDIO_BEEP=默认提示音链接
AUDIO_ACTIVE=唤醒提示音链接
AUDIO_ERROR=出错了提示音链接
# 提示音效(可选)
# AUDIO_SILENT=静音音频链接
# AUDIO_BEEP=默认提示音链接
# AUDIO_ACTIVE=唤醒提示音链接
# AUDIO_ERROR=出错了提示音链接

# Doubao TTS
TTS_DOUBAO=豆包 TTS 接口
SPEAKERS_DOUBAO=豆包 TTS 音色列表接口
# Doubao TTS(可选)
# TTS_DOUBAO=豆包 TTS 接口
# SPEAKERS_DOUBAO=豆包 TTS 音色列表接口
File renamed without changes.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# v1.2.0

- 更新默认模型为 gpt-4o

# v1.1.0

- 新增 Arm64 Docker 镜像
Expand Down
34 changes: 14 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,39 +17,35 @@
- **🔊 自定义 TTS**。厌倦了小爱同学的语音?帮你解锁[「豆包」](https://doubao.com)同款音色,就像真人在回你的消息。
- **🤖️ 智能家居 Agent**。心情不好?小爱立刻懂你,自动帮你播放喜欢的音乐,调节灯光,逗你开心。_TODO_

## ⚡️ 使用教程
## 🚀 启动项目

无论你是电脑小白还是编程高手,都可以轻松拥有自己的专属 `MiGPT`
`MiGPT` 有两种启动方式: [Docker](#-docker)[Node.js](#-Node.js)

### 🚀 启动项目

`MiGPT` 有两种启动方式: [Docker](#-docker)[NPM](#%EF%B8%8F-npm)

#### 📦 Docker
### Docker

[![Docker Image Version](https://img.shields.io/docker/v/idootop/mi-gpt?color=%23086DCD&label=docker%20image)](https://hub.docker.com/r/idootop/mi-gpt)

对于电脑小白或者不想自己配置代码运行环境(Node)的同学,可以使用 Docker 启动方式。

请先按照[「配置参数」](#%EF%B8%8F-配置参数)章节,配置好你的 `.env``.migpt.js` 文件。然后使用以下命令启动 docker:
请先按照[「配置参数」](#配置参数)章节,配置好你的 `.env``.migpt.js` 文件。然后使用以下命令启动 docker:

```shell
docker run -d --env-file $(pwd)/.env \
-v $(pwd)/.migpt.js:/app/.migpt.js \
idootop/mi-gpt:latest
```

#### ⭐️ NPM
### Node.js

[![npm version](https://badge.fury.io/js/mi-gpt.svg)](https://www.npmjs.com/package/mi-gpt)

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

```shell
npm install mi-gpt # 安装依赖
```

然后,创建并启动 `MiGPT` 实例。初始化参数请看下面的[「配置参数」](#%EF%B8%8F-配置参数)章节。
然后,创建并启动 `MiGPT` 实例。初始化参数请看下面的[「配置参数」](#配置参数)章节。

```typescript
import { MiGPT } from "mi-gpt";
Expand All @@ -68,9 +64,9 @@ async function main() {
main();
```

### ⚙️ 配置参数
## ⚙️ 配置参数

#### 📖 环境变量
### 环境变量

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

Expand All @@ -83,9 +79,9 @@ main();
| `MI_PASS` | 账户密码 | `"123456"` |
| `MI_DID` | 小爱音箱 ID 或名称 | `"小爱音箱 Pro"` |
| **OpenAI** | | |
| `OPENAI_MODEL` | 使用的 OpenAI 模型 | `gpt-3.5-turbo-0125` |
| `OPENAI_MODEL` | 使用的 OpenAI 模型 | `gpt-4o` |
| `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"` |
Expand All @@ -94,9 +90,9 @@ main();
| `TTS_DOUBAO` | 豆包 TTS 接口 | `"https://example.com/tts.wav"` |
| `SPEAKERS_DOUBAO` | 豆包 TTS 音色列表接口 | `"https://example.com/tts-speakers"` |

#### 🚗 .migpt.js
### .migpt.js

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

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

Expand Down Expand Up @@ -141,12 +137,10 @@ main();

## 🚨 免责声明

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

## ❤️ 鸣谢

- https://www.mi.com/
- https://openai.com/
- https://github.com/yihong0618/xiaogpt
- https://github.com/inu1255/mi-service
- https://github.com/Yonsm/MiService
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"fs-extra": "^11.2.0",
"https-proxy-agent": "^7.0.4",
"mi-service-lite": "^2.3.0",
"openai": "^4.28.0",
"openai": "^4.47.1",
"prisma": "^5.8.1"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/services/openai.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class OpenAIClient {
jsonMode,
requestId,
trace = false,
model = kEnvs.OPENAI_MODEL ?? "gpt-3.5-turbo-0125",
model = kEnvs.OPENAI_MODEL ?? "gpt-4o",
} = options;
if (trace && this.traceInput) {
this._logger.log(
Expand Down Expand Up @@ -108,7 +108,7 @@ class OpenAIClient {
requestId,
onStream,
trace = false,
model = kEnvs.OPENAI_MODEL ?? "gpt-3.5-turbo-0125",
model = kEnvs.OPENAI_MODEL ?? "gpt-4o",
} = options;
if (trace && this.traceInput) {
this._logger.log(
Expand Down

0 comments on commit df52901

Please sign in to comment.