OpenAI on Wechat

## ```

```放在开头

```

基于ChatGPT的微信聊天机器人，通过 [OpenAI](https://github.com/openai/openai-quickstart-python) 接口生成对话内容，使用 [itchat](https://github.com/littlecodersh/ItChat) 实现微信消息的接收和自动回复。已实现的特性如下：

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

## 部署

### 1. OpenAI账号注册

前往 [OpenAI注册页面](https://beta.openai.com/signup) 创建账号，参考这篇 [教程](https://www.cnblogs.com/damugua/p/16969508.html) 可以通过虚拟手机号来接收验证码。创建完账号则前往 [API管理页面](https://beta.openai.com/account/api-keys) 创建一个 API Key 并保存下来，后面需要在项目中配置这个key。

> 项目中使用的对话模型是 davinci，计费方式是每1k字 (包含请求和回复) 消耗 $0.02，图片生成是每张消耗 $0.016，账号创建有免费的 $18 额度，使用完可以更换邮箱重新注册。

### 2.运行环境

支持 Linux、MacOS、Windows 系统（可在Linux服务器上长期运行)，同时需安装 `Python`。

> 建议Python版本在 3.7.1~3.9.X 之间，3.10及以上版本在 MacOS 可用，其他系统上不确定能否正常运行。

1.克隆项目代码：

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

2.安装所需核心依赖：

```bash
pip3 install itchat-uos==1.5.0.dev0
pip3 install --upgrade openai
```

注：`itchat-uos`使用指定版本1.5.0.dev0，`openai`使用最新版本，需高于0.25.0。

## 配置

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

```bash
cp config-template.json config.json
```

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

```bash
# config.json文件内容示例
{ 
  "open_ai_api_key": "YOUR API KEY"                           # 填入上面创建的 OpenAI API KEY
  "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.其他配置

* 对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词前缀来触发，对应配置 `image_create_prefix `
* 关于OpenAI对话及图片接口的参数配置（内容自由度、回复字数限制、图片大小等），可以参考 [对话接口](https://beta.openai.com/docs/api-reference/completions) 和 [图像接口](https://beta.openai.com/docs/api-reference/completions) 文档直接在 [代码](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/bot/openai/open_ai_bot.py) `bot/openai/open_ai_bot.py` 中进行调整
* `conversation_max_tokens`：表示能够记忆的上下文最大字数（一问一答为一组对话，如果累积的对话字数超出限制，就会优先移除最早的一组对话）
* `character_desc` 配置中保存着你对机器人说的一段话，他会记住这段话并作为他的设定，你可以为他定制任何人格

## 运行

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

```bash
python3 app.py
```

终端输出二维码后，使用微信进行扫码，当输出 "Start auto replying" 时表示自动回复程序已经成功运行了（注意：用于登录的微信需要在支付处已完成实名认证）。

2.如果是  **服务器部署** ，则使用nohup命令在后台运行：

```bash
touch nohup.out                                   # 首次运行需要新建日志文件   
nohup python3 app.py & tail -f nohup.out          # 在后台运行程序并通过日志输出二维码
```

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

[scode type="green" size="small"]

多账号支持：将 项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。

特殊指令：用户向机器人发送 #清除记忆 即可清空该用户的上下文记忆。

\[\/scode]

## Docker部署

### 快速开始

启动容器运行，执行以下命令：

```bash
docker-compose up    
```

或

```bash
# 本地构建容器Image
chmod +x build.alpine.sh           # 构建脚本添加执行权限
./build.alpine.sh                  # 构建容器，基于alpine
# 启动容器
docker run -it --name sample-chatgpt-on-wechat --env OPEN_AI_API_KEY=sk-YourOpenApiKey zhayujie/chatgpt-on-wechat:1.0.0-alpine  
```

## 使用环境变量和运行时配置修改

1. 直接在Shell中使用 `--env`参数覆盖环境变量，实现修改运行参数，参考命令:

```bash
docker run -it --name sample-chatgpt-on-wechat --env OPEN_AI_API_KEY=sk-YourOpenApiKey --env CONVERSATION_MAX_TOKENS=1000 zhayujie/chatgpt-on-wechat:1.0.0-alpine  
```

2. 或者，使用 `--env-file=`配合env文件覆盖环境变量，实现修改运行参数，参考命令:

```bash
docker run -it --name sample-chatgpt-on-wechat --env-file=.env zhayujie/chatgpt-on-wechat:1.0.0-alpine  
```

3. 或者，使用 `-v`替换容器中的 `config.json`，实现修改运行参数，参考命令:

```bash
docker run -it --name sample-chatgpt-on-wechat -v YOUR_PATH_TO_CONFIG:/app/config.json zhayujie/chatgpt-on-wechat:1.0.0-alpine  
```

4. 可用环境变量，可以参考示例 `.env`文件

```bash
OPEN_AI_API_KEY=YOUR API KEY
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训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。
```

### 开始构建Docker Image

#### 使用 docker build构建

1. 构建Image，执行以下命令：

```bash
chmod +x build.alpine.sh           # 构建脚本添加执行权限
./build.alpine.sh                  # 构建容器，基于alpine
```

```bash
adocker run -it --name sample-chatgpt-on-wechat zhayujie/chatgpt-on-wechat:1.0.0-alpine  
```

2. 构建Image完成后启动容器，执行以下命令：

### 使用 docker-compose构建

1. 构建Image并启动, 执行以下命令：

```bash
docker-compose up --build  
```

2. docker-compose.yaml示例：

```yaml
   version: '2.0'
   services:
     chatgpt-on-wechat:
       build:
         context: ./
         dockerfile: Dockerfile.alpine
       image: zhayujie/chatgpt-on-wechat:1.0.0-alpine
       container_name: sample-chatgpt-on-wechat
       environment:
         OPEN_AI_API_KEY: 'YOUR API KEY'
         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. 使用构建参数 `--build-arg`设置 `CHATGPT_ON_WECHAT_VER`构建参数，可以指定chatgpt-on-wechat的[Tag](https://github.com/zhayujie/chatgpt-on-wechat/tags)版本。

```bash
docker build -f Dockerfile.alpine \
             --build-arg CHATGPT_ON_WECHAT_VER=1.0.0 \
             -t zhayujie/chatgpt-on-wechat:1.0.0-alpine .
```

2. 修改 `Dockerfile.alpine` 或 `Dockerfile.debian` 文件里第9行中 API_KEY 的配置，可以在构建时直接将API_KEY构建进Image。

```bash
BUILD_OPEN_AI_API_KEY='YOUR OPEN AI KEY HERE'   
```

## 其他便利工具

我们在 `docker/sample-chatgpt-on-wechat` 下提供了 Makefile 脚本，方便进入容器：

```bash
cd sample-chatgpt-on-wechat          # 进入sample-chatgpt-on-wechat目录
make run_i                           # 使用交互式方式启动容器
```

命令格式为：

```bash
make [echo|stop|rm|run_d|run_i]
# make echo       #回显容器名称
# make stop       #停止容器 
# make rm         #删除容器 
# make run_d      #使用守护式方式启动容器
# make run_i      #使用交互式方式启动容器
```

`

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

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

部署

1. OpenAI账号注册

前往 OpenAI注册页面创建账号，参考这篇教程可以通过虚拟手机号来接收验证码。创建完账号则前往 API管理页面创建一个 API Key 并保存下来，后面需要在项目中配置这个key。

项目中使用的对话模型是 davinci，计费方式是每1k字 (包含请求和回复) 消耗 $0.02，图片生成是每张消耗 $0.016，账号创建有免费的 $18 额度，使用完可以更换邮箱重新注册。

2.运行环境

支持 Linux、MacOS、Windows 系统（可在Linux服务器上长期运行)，同时需安装 Python。

建议Python版本在 3.7.1~3.9.X 之间，3.10及以上版本在 MacOS 可用，其他系统上不确定能否正常运行。

1.克隆项目代码：

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

2.安装所需核心依赖：

pip3 install itchat-uos==1.5.0.dev0
pip3 install --upgrade openai

注：itchat-uos使用指定版本1.5.0.dev0，openai使用最新版本，需高于0.25.0。

配置

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

cp config-template.json config.json

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

# config.json文件内容示例
{ 
  "open_ai_api_key": "YOUR API KEY"                           # 填入上面创建的 OpenAI API KEY
  "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.其他配置

对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词前缀来触发，对应配置 image_create_prefix
关于OpenAI对话及图片接口的参数配置（内容自由度、回复字数限制、图片大小等），可以参考对话接口和图像接口文档直接在代码 bot/openai/open_ai_bot.py 中进行调整
conversation_max_tokens：表示能够记忆的上下文最大字数（一问一答为一组对话，如果累积的对话字数超出限制，就会优先移除最早的一组对话）
character_desc 配置中保存着你对机器人说的一段话，他会记住这段话并作为他的设定，你可以为他定制任何人格

运行

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

python3 app.py

2.如果是 服务器部署 ，则使用nohup命令在后台运行：

touch nohup.out                                   # 首次运行需要新建日志文件   
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 up

或

# 本地构建容器Image
chmod +x build.alpine.sh           # 构建脚本添加执行权限
./build.alpine.sh                  # 构建容器，基于alpine
# 启动容器
docker run -it --name sample-chatgpt-on-wechat --env OPEN_AI_API_KEY=sk-YourOpenApiKey zhayujie/chatgpt-on-wechat:1.0.0-alpine

使用环境变量和运行时配置修改

直接在Shell中使用 --env参数覆盖环境变量，实现修改运行参数，参考命令:

docker run -it --name sample-chatgpt-on-wechat --env OPEN_AI_API_KEY=sk-YourOpenApiKey --env CONVERSATION_MAX_TOKENS=1000 zhayujie/chatgpt-on-wechat:1.0.0-alpine

或者，使用 --env-file=配合env文件覆盖环境变量，实现修改运行参数，参考命令:

docker run -it --name sample-chatgpt-on-wechat --env-file=.env zhayujie/chatgpt-on-wechat:1.0.0-alpine

或者，使用 -v替换容器中的 config.json，实现修改运行参数，参考命令:

docker run -it --name sample-chatgpt-on-wechat -v YOUR_PATH_TO_CONFIG:/app/config.json zhayujie/chatgpt-on-wechat:1.0.0-alpine

可用环境变量，可以参考示例 .env文件

OPEN_AI_API_KEY=YOUR API KEY
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训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。

开始构建Docker Image

使用 docker build构建

构建Image，执行以下命令：

chmod +x build.alpine.sh           # 构建脚本添加执行权限
./build.alpine.sh                  # 构建容器，基于alpine

adocker run -it --name sample-chatgpt-on-wechat zhayujie/chatgpt-on-wechat:1.0.0-alpine

构建Image完成后启动容器，执行以下命令：

使用 docker-compose构建

构建Image并启动, 执行以下命令：

docker-compose up --build

docker-compose.yaml示例：

version: '2.0'
services:
  chatgpt-on-wechat:
    build:
      context: ./
      dockerfile: Dockerfile.alpine
    image: zhayujie/chatgpt-on-wechat:1.0.0-alpine
    container_name: sample-chatgpt-on-wechat
    environment:
      OPEN_AI_API_KEY: 'YOUR API KEY'
      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训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。'

其他构建用法

使用构建参数 --build-arg设置 CHATGPT_ON_WECHAT_VER构建参数，可以指定chatgpt-on-wechat的Tag版本。

docker build -f Dockerfile.alpine \
             --build-arg CHATGPT_ON_WECHAT_VER=1.0.0 \
             -t zhayujie/chatgpt-on-wechat:1.0.0-alpine .

修改 Dockerfile.alpine 或 Dockerfile.debian 文件里第9行中 API_KEY 的配置，可以在构建时直接将API_KEY构建进Image。

BUILD_OPEN_AI_API_KEY='YOUR OPEN AI KEY HERE'

其他便利工具

我们在 docker/sample-chatgpt-on-wechat 下提供了 Makefile 脚本，方便进入容器：

cd sample-chatgpt-on-wechat          # 进入sample-chatgpt-on-wechat目录
make run_i                           # 使用交互式方式启动容器

命令格式为：

make [echo|stop|rm|run_d|run_i]
# make echo       #回显容器名称
# make stop       #停止容器 
# make rm         #删除容器 
# make run_d      #使用守护式方式启动容器
# make run_i      #使用交互式方式启动容器

最后修改：2023 年 09 月 10 日

如果觉得我的文章对你有用，请随意赞赏

OpenAI on Wechat

`

部署

1. OpenAI账号注册

2.运行环境

配置

配置说明：

1.个人聊天

2.群组聊天

3.其他配置

运行

Docker部署

快速开始

使用环境变量和运行时配置修改

开始构建Docker Image

使用 docker build构建

使用 docker-compose构建

其他构建用法

其他便利工具

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

Kubernetes集群搭建

编译安装Python3并切换系统默认版本

好久不见

Typecho-Handsome博客迁移

.

VPS搭建x-ui面板

自建哔哩漫游解析服务器

PagerMaid-Pyro

为Linux实例开启root用户远程登录

编译安装Python3并切换系统默认版本

OpenAI on Wechat

Rei

`

部署

1. OpenAI账号注册

2.运行环境

配置

配置说明：

1.个人聊天

2.群组聊天

3.其他配置

运行

Docker部署

快速开始

使用环境变量和运行时配置修改

开始构建Docker Image

使用 docker build构建

使用 docker-compose构建

其他构建用法

其他便利工具

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

OpenAI on Wechat

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款