【Docker】部署chatgpt-on-wechat

時光2024-01-162024-12-13

一、项目介绍

chatgpt-on-wechat (cow) 项目是使用 ChatGPT 搭建的智能聊天机器人，在GPT3.5/4.0 API 及 itchat框架的基础上实现，支持个人微信、公众号、企业微信部署，能生成文本、语音和图片，访问操作系统和互联网。

最新版本支持的功能如下：

多端部署： 可接入个人微信、微信公众号、企业微信应用
基础对话： 私聊及群聊的消息智能回复，支持多轮会话上下文记忆，支持 GPT-3, GPT-3.5, GPT-4, 文心一言模型
语音识别： 可识别语音消息，通过文字或语音回复，支持 azure, baidu, google, openai 等多种语音模型
图片生成： 支持图片生成和图生图（如照片修复），可选择 Dell-E, stable diffusion, replicate, Midjourney 模型
丰富插件： 支持个性化插件扩展，已实现多角色切换、文字冒险、敏感词过滤、聊天记录总结等插件
Tool工具： 与操作系统和互联网交互，支持最新信息搜索、数学计算、天气和资讯查询、网页总结，基于 chatgpt-tool-hub 实现
知识库： 通过上传知识库文件自定义专属机器人，可作为数字分身、领域知识库、智能客服使用，基于 LinkAI 实现

项目地址 (Github)： https://github.com/zhayujie/chatgpt-on-wechat

项目地址 (Gitee)： https://gitee.com/zhayujie/chatgpt-on-wechat

演示： 视频demo

二、安装步骤

1、下载 `docker-compose.yml` 文件

1	wget https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml

2、修改`docker-compose.yml`文件

需修改如下配置

OPEN_AI_API_KEY ：你的OpenAI API KEY

SINGLE_CHAT_PREFIX : 私聊时文本需要包含该前缀才能触发机器人回复

GROUP_NAME_WHITE_LIST : 开启自动回复的群名称列表

此处我稍微做了一些调整，修改了默认端口，分别映射到自定义端口上

chatgpt-on-wechat 服务默认使用以下端口：

80端口：用于访问 Web 界面，即聊天界面。
8000端口：用于与微信服务器进行通信，接收和发送消息。
8888端口：用于与 OpenAI GPT-3 API 进行通信，发送用户输入并接收生成的回复。

version: '2.0'
services:
  chatgpt-on-wechat:
    image: zhayujie/chatgpt-on-wechat
    container_name: chatgpt-on-wechat
    security_opt:
      - seccomp:unconfined
    ports:
      - 8801:80
      - 8802:8000
      - 8803:8888
    environment:
      OPEN_AI_API_KEY: 'xxxxxxxxxxxxx'
      MODEL: 'gpt-3.5-turbo'
      PROXY: ''
      SINGLE_CHAT_PREFIX: '["bot", "@bot"]'
      SINGLE_CHAT_REPLY_PREFIX: '"[bot] "'
      GROUP_CHAT_PREFIX: '["@bot"]'
      GROUP_NAME_WHITE_LIST: '["時光gpt测试群", "ChatGPT测试群"]'
      IMAGE_CREATE_PREFIX: '["画", "看", "找"]'
      CONVERSATION_MAX_TOKENS: 1000
      SPEECH_RECOGNITION: 'False'
      CHARACTER_DESC: '你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。'
      EXPIRES_IN_SECONDS: 3600
      USE_GLOBAL_PLUGIN_CONFIG: 'True'
      USE_LINKAI: 'False'
      LINKAI_API_KEY: ''
      LINKAI_APP_CODE: ''

更多环境变量参考以下配置

{
  "open_ai_api_key": "YOUR API KEY",                          # 填入上面创建的 OpenAI API KEY
  "model": "gpt-3.5-turbo",                                   # 模型名称, 支持 gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, wenxin, xunfei
  "proxy": "",                                                # 代理客户端的ip和端口，国内环境开启代理的需要填写该项，如 "127.0.0.1:7890"
  "single_chat_prefix": ["bot", "@bot"],                      # 私聊时文本需要包含该前缀才能触发机器人回复
  "single_chat_reply_prefix": "[bot] ",                       # 私聊时自动回复的前缀，用于区分真人
  "group_chat_prefix": ["@bot"],                              # 群聊时包含该前缀则会触发机器人回复
  "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
  "group_chat_in_one_session": ["ChatGPT测试群"],              # 支持会话上下文共享的群名称  
  "image_create_prefix": ["画", "看", "找"],                   # 开启图片回复的前缀
  "conversation_max_tokens": 1000,                            # 支持上下文记忆的最多字符数
  "speech_recognition": false,                                # 是否开启语音识别
  "group_speech_recognition": false,                          # 是否开启群组语音识别
  "use_azure_chatgpt": false,                                 # 是否使用Azure ChatGPT service代替openai ChatGPT service. 当设置为true时需要设置 open_ai_api_base，如 https://xxx.openai.azure.com/
  "azure_deployment_id": "",                                  # 采用Azure ChatGPT时，模型部署名称
  "azure_api_version": "",                                    # 采用Azure ChatGPT时，API版本
  "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。",  # 人格描述
  # 订阅消息，公众号和企业微信channel中请填写，当被订阅时会自动回复，可使用特殊占位符。目前支持的占位符有{trigger_prefix}，在程序中它会自动替换成bot的触发词。
  "subscribe_msg": "感谢您的关注！\n这里是ChatGPT，可以自由对话。\n支持语音对话。\n支持图片输出，画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。",
  "use_linkai": false,                                        # 是否使用LinkAI接口，默认关闭，开启后可国内访问，使用知识库和MJ
  "linkai_api_key": "",                                       # LinkAI Api Key
  "linkai_app_code": ""                                       # LinkAI 应用code
}

3、启动容器

1	docker compose up -d

运行 docker ps 能查看到 NAMES 为 chatgpt-on-wechat 的容器即表示运行成功

最后运行以下命令可查看容器运行日志，扫描日志中的二维码即可完成登录：

1	docker logs -f chatgpt-on-wechat

4、如何使用

成功运行之后日志中会输出 “Start auto replying”，这表示你用于扫码登录的账号已经变身为机器人了，让你的好友给你发消息或在群聊@你都会触发自动回复，效果如下图：

5、停止容器

1	docker compose down

注意：如果修改了 docker-compose.yml 中的配置，需要关闭容器后再重新启动才能生效，只执行 docker restart 是不起作用的。

6、常见问题

如果发送消息没有回复，对于私聊场景确认下消息是否携带了触发词，对应配置 single_chat_prefix，对于群聊场景要确认该群名称是否配置在群组白名单 (group_name_white_list) 中。
如果机器人回复 “我现在有点累了” 或 “我连接不到你的网络” 等，一般是访问openAI接口失败，需查看日志中的具体报错信息来定位，可能是网络不通、openAI账号额度不足、访问频率超限等原因。
可能存在一定账号被限制的风险，建议仅用于技术研究或娱乐，不要过高频率使用。

常见问题查看 FAQs，或直接与在线项目小助手对话。