/wechat-chatgpt

基于 ChatGPT 的 AI 助手微信机器人，支持个人微信与企业微信，支持客服模式并实时更新

Primary LanguageTypeScript

ChatGPT 微信机器人

三分钟，创建一个 ChatGPT AI 微信（企业微信）小助手。

  • 负载均衡：多个 OpenAI Token 增强其稳定性
  • 场景模式：可通过 PROMPT 配置机器人为专业的翻译、面试官、医生等
  • 群聊控制：可控制在那些群开启群聊，或关闭群聊
  • 私聊控制：可控制在那些好友开启私聊，或关闭私聊
  • 词语触发：支持通过关键字触发私聊、群聊的 AI 机器人
  • 支持日志：可查看每天多少条记录
  • 反向代理：为不同地区提供更快的 OpenAI 的代理 API 地址
  • 企业微信：支持企业微信登录
  • 自动重启：当发生异常，机器人自动退出后，支持自动重启
  • 错误重试：当 chatgpt 未回复时，尝试三次，减少 chatgpt 罢工几率
  • 命名模式：支持为你的机器人命名
  • 连续对话：支持上下文消息
  • 管理模式：内置管理员模式，可查看每个用户的对话次数
  • 查看余额：可查看该 key 还有多少余额，仅供管理员查看
  • PDF阅读：可阅读 PDF 等文件，并根据 PDF 内容进行回答
  • URL阅读：可阅读 URL 等内容，并根据 URL 内容进行回答
  • 自动总结：转发公众号文章链接至机器人，自动总结内容

如果需要搭建基于 ChatGPT 的飞书、钉钉、企微内部应用、公众号机器人，可参考个人的另一项目 feishu-chatgpt。

环境要求

  1. node.js >= 18
  2. 基于 Web 协议的机器人最近有可能被封禁，可采用 iPad 其它协议的机器人，可在 index.ts 中更换其他 Puppet。

配置与环境变量

编辑 ./config.ts 配置文件。

export default {
  // 自动同意添加好友的口令
  acceptText: /ChatGPT/,

  // 如果微信机器人跑在国内，必须配置该项，其为官方 API 在国内的代理
  baseURL: process.env.BASE_URL || 'https://api.openai.com/v1',
  apiKey: process.env.OPEN_API_KEY.split(','),
  model: process.env.GPT_MODEL || 'gpt-3.5-turbo',
  // 通过 prompt 可以配置为各种各样的机器人，如翻译、面试、SQL 生成器等。
  prompt: process.env.PROMPT || '',

  // 判断在哪里开启机器人，默认是私聊以及艾特机器人的群聊
  // 是否开启群聊模式，可使用正则以及 boolen，如果是正则用以决定在那些群开启群聊
  enableGroup: /^(技术交流群|面试直通车|学习)$/,
  // enableGroup: true,

  // 是否开启私聊模式，可使用正则以及 boolen，如果是正则用以决定与谁私聊
  // enablePrivate: true,
  enablePrivate: /(山月)/,

  // 私聊模式时，配置关键词触发
  groupPrefix: '',

  // 私聊模式时，配置关键词触发
  privatePrefix: '山月',

  // 开启异常报错上传 sentry
  sentryDsn: process.env.SENTRY_DSN || ''
}

对于 OpenAI 的 key 及国内代理 BaseURL 等敏感数据，可以置于环境变量中，编辑 .env 配置文件。

OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC"

其中，OPEN_API_KEY 支持多个 key 负载均衡，在环境变量中使用 , 隔开

OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC,k-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC,k-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC"

企业微信

如果需要企业微信作为机器人，请编辑环境变量，更换 PUPPET

# 如果是企业微信的话，使用以下两行代码
WECHATY_PUPPET_SERVICE_TOKEN="puppet_workpro_xxxxxxxxx"
WECHATY_PUPPET="wechaty-puppet-service"

步骤

  1. 编辑环境变量
$ cp .example.env .env

并编辑以下环境变量。注意，如果你在国内服务器部署，必须配置 BASE_URL 环境变量，其为 OpenAI 在国内的代理 API，需自行搭建。

# 如果部署在 vercel 等境外服务器，则不需要此项配置
# 如果部署在境内，可以使用山月的临时代理 API，不过强烈建议自行搭建
BASE_URL="https://ai.devtool.tech/proxy"
OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  1. 编辑是否允许群聊以及私聊

编辑 ./config.ts，配置是否开启群聊以及私聊模式。

{
  // 判断在哪里开启机器人，默认是私聊以及艾特机器人的群聊
  // 是否开启群聊模式，可使用正则以及 boolen，如果是正则用以决定在那些群开启群聊
  enableGroup: true,

  // 或者只允许在特定的群开启群聊
  enableGroup: /^(技术交流群|面试直通车|学习)$/,

  // 是否开启私聊模式，可使用正则以及 boolen，如果是正则用以决定与谁私聊
  enablePrivate: true,

  // 或者只允许对特定的人开启私聊
  enablePrivate: /(山月)/,

  // 私聊模式时，配置关键词触发
  groupPrefix: '',

  // 私聊模式时，配置关键词触发
  privatePrefix: '山月',
}
  1. 开启一个微信机器人，使用将要作为机器人的微信扫码进行登录
$ pnpm i

$ pnpm start

此时会出现二维码链接，通过链接链接打开二维码，扫码登录。待出现登录成功字样时，则机器人成功开启。

  1. 健康检查

向机器人发送 /ping 指定，它会默认回复 pong。以确保机器人已经正常工作。

  1. 与机器人对话

部署方式

Docker

# 启动服务，并在后台启动
$ docker compose up -d --build

# 查看日志，并扫码登录
$ docker compose logs --tail 100 --follow

裸机部署

$ pnpm start

商务合作与交流

如果开源版无法满足您团队或公司的需求，推荐我们团队商业开发的基于 ChatGPT 的飞书、钉钉、企微内部应用、公众号、个人微信、企业微信的 SaaS 平台。

  1. 基于 ChatGPT 的飞书、钉钉、企微内部应用、公众号、个人微信、企业微信的 SaaS 平台 (内测中)
  2. 企业级私有部署服务或者 Sass 部署
  3. 若仅仅需要提供部署服务指导，可付费咨询，订阅包年服务
  4. 若需二次开发定制服务，可付费开发