MiGPT-Next 项目启动与配置教程

1. 项目目录结构及介绍

MiGPT-Next 项目目录结构如下：

migpt-next/
├── apps/                   # 包含示例应用
│   └── example/            # 示例应用目录
├── packages/               # 可能包含的子包
├── docs/                   # 文档目录
├── .vscode/                # VSCode 配置文件
├── .gitignore              # Git 忽略文件
├── .npmrc                  # npm 配置文件
├── LICENSE                 # 开源协议文件
├── README.md               # 项目说明文件
├── agreement.md            # 用户协议文件
├── biome.json              # 配置文件
├── lefthook.yml            # Git 钩子配置文件
├── package.json            # 项目配置文件
└── pnpm-lock.yaml          # pnpm 锁文件

• apps/: 包含项目的示例应用。
• packages/: 可能包含项目依赖的子包。
• docs/: 存放项目文档的地方。
• .vscode/: VSCode 编辑器配置。
• .gitignore: 指定 Git 忽略的文件。
• .npmrc: npm 配置文件。
• LICENSE: 项目的开源协议。
• README.md: 项目的说明文档。
• agreement.md: 用户协议。
• biome.json: 可能包含项目配置信息。
• lefthook.yml: 配置 Git 钩子。
• package.json: 定义项目的依赖和脚本。
• pnpm-lock.yaml: pnpm 锁文件，保证依赖的一致性。

2. 项目的启动文件介绍

项目的启动方式有两种：使用 Docker 和 Node.js。

• Docker 启动:

  • 克隆项目代码到本地。
  • 进入配置文件所在目录 migpt-next/apps/example。
  • 修改 config.js 文件中的配置信息。
  • 运行 Docker 命令启动项目。

  docker run -it --rm -v $(pwd)/config.js:/app/config.js idootop/migpt-next:latest
  

• Node.js 启动:

  • 在项目中安装 @mi-gpt/next 依赖。
  • 使用 import 语句引入 MiGPT。
  • 调用 MiGPT.start() 方法启动项目。

  import { MiGPT } from "@mi-gpt/next";
  
  async function main() {
    await MiGPT.start({
      // ... 配置参数
    });
  }
  
  main();
  

3. 项目的配置文件介绍

项目的配置文件是 config.js，位于 migpt-next/apps/example 目录下。以下是配置文件的基本结构和需要配置的参数：

export default {
  speaker: {
    userId: "123456",        // 用户ID
    password: "xxxxxxxx",     // 密码
    did: "Xiaomi 智能音箱 Pro" // 设备ID
  },
  openai: {
    model: "gpt-4.1-mini",    // 模型类型
    baseURL: "https://api.openai.com/v1", // OpenAI API 基础URL
    apiKey: "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxx" // OpenAI API 密钥
  },
  prompt: {
    system: "你是一个智能助手，请根据用户的问题给出回答。" // 系统提示信息
  },
  // ... 其他配置
};

确保替换示例中的默认值（如用户ID、密码和API密钥）为实际的值，以正确连接到小爱音箱和OpenAI服务。