微信上的ChatGPT

🤖️ 将你的微信变成ChatGPT 只需两步！ 🤖️

功能

本项目基于我之前贡献的这个超棒的项目，结合Wechaty SDK和OpenAI API，实现了以下功能：

• 快速且稳定的连接到一组具有不同功能的AI模型，通常是为ChatGPT提供支持的gpt-4o和gpt-3.5-turbo
• 在云服务器Railway上实现稳定、持久且快速的部署

0. 目录

• 微信上的ChatGPT
  • 1. 如何部署这个机器人？
    • 1.1 本地部署
      • 1.1.1 获取你的OpenAI API密钥
      • 1.1.2 配置环境变量
      • 1.1.3 设置Docker
      • 1.1.4 登录你的微信
    • 1.2 Railway上部署
      • 1.2.1 在Railway上配置
      • 1.2.2 在Railway上部署并登录
      • 1.2.3 在阿里云ComputeNest上部署
  • 2. 有没有什么高级设置？
    • 2.1 错误回复配置
    • 2.2 OpenAI模型配置
    • 2.3 模型功能配置
    • 2.4 添加自定义任务处理器
  • 3. 常见错误及故障排除
    • 3.1 登录或自聊时出现断言错误 🤯
    • 3.2 我无法触发自动回复 🤔
  • 4. 如何参与本项目的贡献？
  • 5. 致谢
  • 感谢你通过给本项目加星来支持我们！

1. 如何部署这个机器人？

你可以选择本地部署或云端部署，随你喜好。

推荐使用云端部署的方法。

1.1 本地部署

1.1.1 获取你的OpenAI API密钥

• openaiApiKey可以在你的OpenAI账户的API密钥页面生成。
• openaiOrganizationID是可选的，可以在你的OpenAI账户的设置页面找到。

---

1.1.2 配置环境变量

你可以将模板文件config.yaml.example复制到一个新的文件config.yaml中，并填入以下配置：

openaiApiKey: "<your_openai_api_key>"
openaiOrganizationID: "<your_organization_id>"
chatgptTriggerKeyword: "<your_keyword>"

或者，你也可以将.env.example文件中的环境变量导出到你的系统中，这是更推荐的方式，可以更好地保护你的OpenAI API密钥：

export OPENAI_API_KEY="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
export OPENAI_ORGANIZATION_KEY="org-XXXXXXXXXXXXXXX"
export CHATGPT_TRIGGER_KEYWORD="Hi bot:"

请注意：

• chatgptTriggerKeyword是用于触发自动回复的关键字：
  • 在私聊中，以该关键字开头的消息会触发自动回复。
  • 在群聊中，以@名字 <关键字>开头的消息会触发自动回复。
• 如果chatgptTriggerKeyword为空字符串，则表示：
  • 在私聊中，所有消息都会触发自动回复。
  • 在群聊中，只有**“@机器人”**才会触发自动回复。

---

1.1.3 设置Docker

1. 构建Docker镜像

docker build -t chatgpt-on-wechat .

2. 启动Docker容器

docker run -v $(pwd)/config.yaml:/app/config.yaml chatgpt-on-wechat

你也可以使用Docker Compose进行构建：

1. 启动容器

docker-compose up -d

2. 查看二维码以登录微信

docker-compose logs -f

---

1.1.4 登录你的微信

成功部署机器人后，请仔细按照Docker容器终端或日志提示操作：

1. 使用手机微信扫描二维码。
2. 点击“登录”以允许桌面登录（我们的机器人就运行在桌面上）。
3. 等待几秒钟，就可以开始聊天了！

🤖 尽情享受你的强大聊天机器人吧！ 🤖

---

1.2 在Railway上部署

点击下方按钮，即可分叉此仓库并在Railway上部署！

---

1.2.1 在Railway上配置

请填写以下内容：

1. 你的分叉仓库名称（可以随意命名）。
2. 选择是否将其设为私有（由你决定）。
3. 环境变量（关于如何获取OpenAI API密钥，请参考1.1.1 获取你的OpenAI API密钥）。

请注意：

务必在Railway平台上设置环境变量，而不是直接写入config.yaml文件中。强烈建议不要将你的OpenAI API密钥明文写入公开仓库中。任何拥有该密钥的人都可以访问OpenAI的服务，如果你为此付费，可能会导致经济损失。

---

1.2.2 在Railway上部署并登录

部署过程是自动化的，首次可能需要几分钟时间。当看到“成功”字样时，点击标签查看详细信息。（这就是你的秘密微信控制台！）

点击“部署日志”，你会看到一切都在准备中，等待二维码弹出。像登录桌面版微信一样扫描它，然后在手机微信上点击“登录”。

最后，一切就绪！你会看到有人给你发送消息的日志，以及聊天机器人自动回复的记录。

1.3 在阿里云 ComputeNest 上部署

在阿里云 ComputeNest 上一键部署：

请按照部署指南，在阿里云上部署 ChatGPT-on-WeChat。支持国内站点和国际站点。

• 部署指南（国内站点）
• 部署指南（国际站点）

切换阿里云控制台的语言，即可查看不同语言的指南。

首先，需要提供云资源配置，例如 ECS 实例类型和网络配置。 同时还需要设置 ChatGPT-On-WeChat 的软件配置。

确认部署后，阿里云 ComputeNest 将在您的阿里云账号下自动创建 ECS 实例，并部署和启动 ChatGPT-on-WeChat 应用程序。

ComputeNest 服务实例部署完成后，请查看“使用说明”以了解如何登录到 ECS 实例。

在 ECS 工作台中运行命令以获取二维码。

像登录桌面版微信一样扫描该二维码，然后在手机微信上点击“登录”。

最后，一切准备就绪！当有人向您发送消息时，您将看到日志记录；每当聊天机器人自动触发回复时，也会有相应的日志显示。

2. 是否有高级自定义设置？

2.1 配置错误回复

当 OpenAI API 出现某些错误时（例如流量过大、未授权等），聊天机器人将自动回复预先配置的消息。

您可以在 src/chatgpt.js 中进行更改：

const chatgptErrorMessage = "🤖️：ChatGPT 摆烂了，请稍后再试～";

---

2.2 配置 OpenAI 模型

您可以根据不同的能力、耗时和成本权衡，选择任何您喜欢的 OpenAI 模型来处理任务。（例如，能力更强的模型响应时间更长）

目前，最新的 GPT-4o 模型已经上线并运行！

由于最新的 gpt-4 模型目前仍处于有限的测试阶段，仅对获得访问权限的用户开放，因此我们目前默认使用 gpt-3.5-turbo 模型。当然，如果您拥有 gpt-4 API 的访问权限，只需将模型更改为 gpt-4 即可，无需其他修改。

根据 OpenAI 官方文档，

GPT-4o（“o”代表“omni”，即多模态）是我们最先进的模型。它支持多模态输入（文本或图像输入，输出文本），并且具有与 GPT-4 Turbo 相同的高智能，但效率更高——生成文本的速度是前者的两倍，价格也便宜 50%。此外，GPT-4o 在视觉能力和非英语语言表现方面，均优于我们现有的其他模型。

GPT-3.5 系列模型可以理解和生成自然语言或代码。GPT-3.5 系列中最强大且最具成本效益的模型是 gpt-3.5-turbo，它专为聊天优化，但也适用于传统的完成任务。

此外，对于同一模型，我们还可以配置数十种参数（例如回答的随机性、最大字数限制等）。以 temperature 参数为例：

较高的值，如 0.8，会使输出更具随机性；而较低的值，如 0.2，则会使输出更加专注和确定性。

您可以在 src/chatgpt.js 中配置所有这些参数：

chatgptModelConfig: object = {
  // 此模型字段为必填项
  model: "gpt-4o",
  // 在下方添加您的 ChatGPT 模型参数
  temperature: 0.8,
  // max_tokens: 2000,
};

更多详细信息，请参阅 OpenAI 模型文档。

---

2.3 配置模型功能

您可以根据不同的任务类型，选择所需的模型功能。（例如，完成文本、编辑文本、生成代码等）

目前，我们使用由 gpt-4o 模型驱动的 createChatCompletion() 方法，其功能为：

接受一系列消息作为输入，并返回由模型生成的消息作为输出。

您可以在 src/chatgpt.js 中进行配置：

const response = await this.openaiApiInstance.createChatCompletion({
  ...this.chatgptModelConfig,
  messages: inputMessages,
});

更多详细信息，请参阅 OpenAI API 文档。

---

2.4 添加自定义任务处理器

您可以添加自己的任务处理器，以扩展此聊天机器人的功能！

在 src/chatgpt.ts 的 ChatGPTBot.onCustimzedTask() 中，编写您自己的任务处理器：

// 例如，如果消息以“Hello”开头，机器人会回复“World！”
if (message.text().startsWith("Hello")) {
  await message.say("World!");
  return;
}

3. 常见错误及故障排除

3.1 登录或自聊时出现断言错误 🤯

• 错误日志：

  uncaughtException AssertionError [ERR_ASSERTION]: 1 == 0
      at Object.equal (/app/node_modules/wechat4u/src/util/global.js:53:14)
      at /app/node_modules/wechat4u/src/core.js:195:16
      at processTicksAndRejections (node:internal/process/task_queues:96:5) {
    code: 2,
    details: 'AssertionError [ERR_ASSERTION]: 1 == 0\n' +
      '    at Object.equal (/app/node_modules/wechat4u/src/util/global.js:53:14)\n' +
      '    at /app/node_modules/wechat4u/src/core.js:195:16\n' +
      '    at processTicksAndRejections (node:internal/process/task_queues:96:5)'
  }
  

• 解决方案：

  • 如果在登录时遇到此错误，请查看 issue #8
  • 如果在自聊时遇到此错误，请查看 issue #38

3.2 无法触发自动回复 🤔

• 解决方案：
  • 部署前，请阅读 1.1.2 配置环境变量 中的触发条件。
  • 部署后，请检查控制台日志中是否有以下内容：
    • 🎯 私聊中的触发关键词为：
    • 🎯 群聊中的触发关键词为：@Name

4. 如何为本项目贡献力量？

非常欢迎您提出问题、fork 本仓库、提交代码并发起 Pull Request。在代码审查通过后，我们将合并您的贡献。我非常期待与大家一起开发更多有趣的功能！

此外，我们还有一些待办事项，计划在未来进行优化：

1. 带上下文的聊天（集成 LangChain）：

   • 为每个私聊或群聊维护当前会话的完整记录
   • 当对话历史过长导致 token 数量超出限制时，动态裁剪或总结历史对话并通过 API 发送
   • 在用户一段时间未回复时，为会话设置超时机制

2. 更多 AI 能力：

   • 集成 OpenAI 的 DALL·E 模型，用于 AI 图像生成。可通过自定义关键词触发（例如：Hi bot, draw...）
   • 集成 OpenAI 的 Whisper 模型，实现语音识别功能。可对语音消息进行转录或翻译

3. 更灵活的部署方式：

   • 制作适用于其他云平台的部署模板
   • 优化部署流程，使其更加健壮，并提高在不同操作系统上的兼容性

5. 致谢

特别感谢以下贡献者：

• @leoncsyang 修复了 Issue #81
• @hdfk7 修复了 Issue #67
• @jichangfeng 合并了 PR #61
• @wenle 合并了 PR #92 和 PR #93

感谢您通过 Star 本项目给予的支持！

ChatGPT-on-WeChat 快速上手指南

将你的微信变成由 GPT-4o 或 GPT-3.5-turbo 驱动的聊天机器人，只需简单几步即可部署。

1. 环境准备

在开始之前，请确保满足以下前置条件：

• 操作系统：Linux、macOS 或 Windows（需安装 Docker）。
• 核心依赖：已安装 Docker 和 Docker Compose。
• 账号要求：
  • 有效的 微信账号（用于扫码登录）。
  • OpenAI API Key：可在 OpenAI API Keys 页面 获取。
  • （可选）OpenAI Organization ID：可在 Settings 页面 获取。

2. 安装与配置

本项目推荐使用 Docker 进行本地部署，既安全又便捷。

第一步：获取配置文件

克隆项目或直接创建配置文件。将示例配置 config.yaml.example 复制为 config.yaml：

cp config.yaml.example config.yaml

第二步：编辑配置

使用文本编辑器打开 config.yaml，填入你的 OpenAI 密钥和触发关键词：

openaiApiKey: "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
openaiOrganizationID: "org-XXXXXXXXXXXXXXX" 
chatgptTriggerKeyword: "Hi bot:"

配置说明：

• openaiApiKey: 必填，你的 OpenAI API 密钥。
• chatgptTriggerKeyword: 触发自动回复的关键词。
  • 私聊：消息以该关键词开头即触发。
  • 群聊：消息格式为 @机器人昵称 <关键词> 时触发。
  • 若设为空字符串 ""：私聊中所有消息均触发；群聊中仅当 @机器人昵称 时触发。

安全提示：也可以选择不修改 yaml 文件，而是通过导出环境变量方式配置（推荐用于生产环境）：

export OPENAI_API_KEY="sk-..."
export CHATGPT_TRIGGER_KEYWORD="Hi bot:"

第三步：构建并运行

在项目根目录下执行以下命令构建镜像并启动容器：

方式 A：使用 Docker 命令

1. 构建镜像：

   docker build -t chatgpt-on-wechat .
   

2. 运行容器（挂载配置文件）：

   docker run -v $(pwd)/config.yaml:/app/config.yaml chatgpt-on-wechat
   

方式 B：使用 Docker Compose（推荐）

1. 启动服务：

   docker-compose up -d
   

2. 查看日志以获取登录二维码：

   docker-compose logs -f
   

3. 基本使用

部署成功后，按照终端或 Docker 日志中的提示进行操作：

1. 扫码登录： 在日志中找到显示的二维码图片（或在 Railway/云服务器控制台查看），使用手机微信扫描该二维码。
2. 确认登录： 在手机微信上点击“登录”按钮（允许网页/桌面端登录）。
3. 开始对话： 登录成功后，机器人即开始运行。
   • 私聊测试：发送 Hi bot: 你好（假设关键词为 Hi bot:），机器人将调用 OpenAI 接口回复。
   • 群聊测试：在群内 @机器人昵称 Hi bot: 今天天气如何，机器人将回复。

此时，你已成功拥有一个基于大模型的微信智能助手！