[ChatGPT] Docker Compose 快速部署基于 chatgpt-on-wechat 的 ChatGPT 的微信机器人

发表于 2023-03-11 更新于 2023-09-02 分类于 WeChat Bot ， ChatGPT ， Artificial Intelligence (AI) 本文字数： 5.2k 阅读时长 ≈ 9 分钟

Docker Compose 快速部署基于 chatgpt-on-wechat 的 ChatGPT 的微信机器人

chatgpt-on-wechat 是基于 ChatGPT 的微信聊天机器人，通过 ChatGPT 接口生成对话内容，使用 itchat 实现微信消息的接收和自动回复。已实现的特性如下：

文本对话：接收私聊及群组中的微信消息，使用 ChatGPT 生成回复内容，完成自动回复
规则定制化：支持私聊中按指定规则触发自动回复，支持对群组设置自动回复白名单
多账号：支持多微信账号同时运行
图片生成：支持根据描述生成图片，并自动发送至个人聊天或群聊
上下文记忆：支持多轮对话记忆，且为每个好友维护独立的上下会话
语音识别：支持接收和处理语音消息，通过文字或语音回复

chatgpt-on-wechat 适合 Python 开发者或者熟悉 Docker 或 Docker Compose 使用的用户

前提条件

Python 开发环境，或者 Docker 和 Docker Compose 的使用环境。本地或服务端均可，取决于你的使用场景
微信账号，并通过微信支付实名认证。（虽然被封号的概率很小，稳妥起见建议使用小号，避免被微信封号造成不便）
OpenAI apikey，以及可以轻松访问 ChatGPT 的网络环境

快速部署

克隆项目代码：

1
2
3

git clone https://github.com/zhayujie/chatgpt-on-wechat

cd chatgpt-on-wechat/

安装依赖：

pip install -r requirements.txt

# 或手动单独安装依赖
# pip3 install itchat-uos==1.5.0.dev0
# pip3 install --upgrade openai

如果使用 Docker 或者 Docker Compose 部署，可以跳过此步骤

配置

配置文件的模板在根目录的 config-template.json 中，需复制该模板创建最终生效的 config.json 文件：

1	cp config-template.json config.json

然后在 config.json 中填入配置，以下是对默认配置的说明，可根据需要进行自定义修改：
config.json 文件内容示例

{ 
  "open_ai_api_key": "YOUR API KEY",                          # 填入上面创建的 OpenAI API KEY
  "proxy": "127.0.0.1:7890",                                  # 代理客户端的ip和端口
  "single_chat_prefix": ["bot", "@bot"],                      # 私聊时文本需要包含该前缀才能触发机器人回复
  "single_chat_reply_prefix": "[bot] ",                       # 私聊时自动回复的前缀，用于区分真人
  "group_chat_prefix": ["@bot"],                              # 群聊时包含该前缀则会触发机器人回复
  "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
  "image_create_prefix": ["画", "看", "找"],                   # 开启图片回复的前缀
  "conversation_max_tokens": 1000,                            # 支持上下文记忆的最多字符数
  "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。"  # 人格描述
}

配置说明：

1.个人聊天
个人聊天中，需要以 bot 或 @bot 为开头的内容触发机器人，对应配置项 single_chat_prefix (如果不需要以前缀触发可以填写 "single_chat_prefix": [""])

机器人回复的内容会以 [bot] 作为前缀，以区分真人，对应的配置项为 single_chat_reply_prefix (如果不需要前缀可以填写"single_chat_reply_prefix": "")

2.群组聊天

群组聊天中，群名称需配置在 group_name_white_list 中才能开启群聊自动回复。如果想对所有群聊生效，可以直接填写 "group_name_white_list": ["ALL_GROUP"]

默认只要被人 @ 就会触发机器人自动回复；另外群聊天中只要检测到以 @bot 开头的内容，同样会自动回复（方便自己触发），这对应配置项 group_chat_prefix

可选配置: group_name_keyword_white_list 配置项支持模糊匹配群名称，group_chat_keyword 配置项则支持模糊匹配群消息内容，用法与上述两个配置项相同。

3.语音识别

添加 "speech_recognition": true 将开启语音识别，默认使用 openai 的 whisper 模型识别为文字，同时以文字回复，目前只支持私聊 (注意由于语音消息无法匹配前缀，一旦开启将对所有语音自动回复)；

添加 "voice_reply_voice": true 将开启语音回复语音，但是需要配置对应语音合成平台的 key，由于 itchat 协议的限制，只能发送语音 mp3 文件，若使用 wechaty 则回复的是微信语音。

4.其他配置

proxy：由于目前 openai 接口某些网络无法访问，需配置代理客户端的地址

对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词前缀来触发，对应配置 image_create_prefix

关于OpenAI对话及图片接口的参数配置（内容自由度、回复字数限制、图片大小等），可以参考对话接口和图像接口文档直接在代码 bot/openai/open_ai_bot.py 中进行调整。

conversation_max_tokens：表示能够记忆的上下文最大字数（一问一答为一组对话，如果累积的对话字数超出限制，就会优先移除最早的一组对话）

character_desc 配置中保存着你对机器人说的一段话，他会记住这段话并作为他的设定，你可以为他定制任何人格

Python 运行

本地运行

如果是开发机本地运行，直接在项目根目录下执行：

1	python3 app.py

终端输出二维码后，使用微信进行扫码，当输出 “Start auto replying” 时表示自动回复程序已经成功运行了（注意：用于登录的微信需要在支付处已完成实名认证）。扫码登录后你的账号就成为机器人了，可以在微信手机端通过配置的关键词触发自动回复 (任意好友发送消息给你，或是自己发消息给好友)，

服务器运行

使用 nohup 命令在后台运行程序：

1	nohup python3 app.py & tail -f nohup.out # 在后台运行程序并通过日志输出二维码

扫码登录后程序即可运行于服务器后台，此时可通过 ctrl+c 关闭日志，不会影响后台程序的运行。使用 ps -ef | grep app.py | grep -v grep 命令可查看运行于后台的进程，如果想要重新启动程序可以先 kill 掉对应的进程。日志关闭后如果想要再次打开只需输入 tail -f nohup.out。

Docker 或 Docker Compose 运行

首先创建或编辑 Dockerfile 文件：

FROM python:3.7.9

RUN apt-get update && \
    apt-get install -y --no-install-recommends \
        wget \
        curl && \
    rm -rf /var/lib/apt/lists/*

ARG WORKDIR=/app
RUN mkdir -p ${WORKDIR}
WORKDIR ${WORKDIR}
ENV WORKDIR=${WORKDIR}

COPY requirement.txt ./
RUN /usr/local/bin/python -m pip install --no-cache --upgrade pip -r requirement.txt

# COPY config.json .
COPY . ./

RUN groupadd -r noroot \
  && useradd -r -g noroot -s /bin/bash -d /home/noroot noroot \
  && chown -R noroot:noroot ${WORKDIR}

USER noroot

CMD ["python", "app.py"]

Docker 运行

# 构建 chatgpt-on-wechat 镜像
docker build -t chatgpt-on-wechat .

# 运行 chatgpt-on-wechat 镜像
docker run -it --rm -v ${PWD}/config.json:/app/config.json chatgpt-on-wechat

-v ${PWD}/config.json:/app/config.json 用于将本地的 config.json 文件挂载到容器内的 /app/config.json 文件，这样就可以在容器内使用本地的配置文件了。

Docker Compose 运行

创建或编辑 docker-compose.yaml 文件：

# docker-compose.yaml
version: '3'

services:
app:
  build:
    context: ./
    dockerfile: Dockerfile
  image: blogbin/chatgpt-on-wechat
  restart: unless-stopped
  volumes:
"./config.json:/app/config.json"