个人微信接入ChatGPT

个人微信接入ChatGPT

CoderJia 148 2024-01-30

chatgpt-on-wechat介绍

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

主要功能

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

  • 多端部署: 可接入 个人微信、微信公众号、企业微信应用;
  • 基础对话: 私聊及群聊的消息智能回复,支持多轮会话上下文记忆,支持 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

准备工作

项目默认使用OpenAI接口,需前往 OpenAI注册页面 创建账号,创建完账号则前往 API管理页面 创建一个 API Key 并保存下来,后面需要在项目中配置这个 API key

申请方式可参考之前的文章:WildCard充值OpenAI API,并使用GPT-4

安装-docker方式

这种安装方式成本最低,还兼容公众号模式

(1) 配置 docker-compose.yml

[root@hecs-141602 chatgpt-on-wechat]# pwd
/root/project/chatgpt-on-wechat
[root@hecs-141602 chatgpt-on-wechat]# wget https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml
--2024-01-27 18:17:34--  https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml
正在连接 154.198.213.49:3128... 已连接。
已发出 Proxy 请求,正在等待回应... 200 OK
长度:908 [application/octet-stream]
正在保存至: “docker-compose.yml”

100%[==========================================================================================================================================================>] 908         --.-K/s 用时 0s  

2024-01-27 18:17:35 (226 MB/s) - 已保存 “docker-compose.yml” [908/908])

[root@hecs-141602 chatgpt-on-wechat]# ls
docker-compose.yml


接着打开文件,修改或添加所需的配置,如 OPEN_AI_API_KEYGROUP_NAME_WHITE_LIST 等必填配置,其他配置参考配置说明。

image-doit.png

配置说明:

"open_ai_api_key": "YOUR API KEY",                          # 填入上面创建的 OpenAI API KEY
"model": "gpt-3.5-turbo",                                   # 模型名称。当use_azure_chatgpt为true时,其名称为Azure上model deployment名称
"open_ai_api_base": "https://api.openai.com/v1"             # 可以填入反代理的域名
"proxy": "",                                                # 代理客户端的ip和端口
"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时,模型部署名称
"character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。",  # 人格描述
# 订阅消息,公众号和企业微信channel中请填写,当被订阅时会自动回复,可使用特殊占位符。目前支持的占位符有{trigger_prefix},在程序中它会自动替换成bot的触发词。
"subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。"

Docker安装的话配置就直接修改 docker-compose.yml文件,大小写不敏感。

(2) 启动容器

在 docker-compose.yml 所在目录下执行以下命令启动容器:

sudo docker compose up -d

image-rxvt.png

运行 sudo docker ps 能查看到 NAMESchatgpt-on-wechat 的容器即表示运行成功。

sudo docker ps

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

sudo docker logs -f chatgpt-on-wechat

image-qdhv.png

(3) 停止容器

执行以下命令可以关闭服务:

sudo docker compose down

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

测试效果

根据配置文件添加召唤助手的前缀,如 bot@bot

24FBC509F56B39861D1D2C91FE6B6D7F.jpg

附:配置说明

配置说明:

1.个人聊天

  • 个人聊天中,需要以 "bot"或"@bot" 为开头的内容触发机器人,对应配置项 single_chat_prefix (如果不需要以前缀触发可以填写 "single_chat_prefix": [""])
  • 机器人回复的内容会以 "[bot] " 作为前缀, 以区分真人,对应的配置项为 single_chat_reply_prefix (如果不需要前缀可以填写 "single_chat_reply_prefix": "")

2.群组聊天

  • 群组聊天中,群名称需配置在 group_name_white_list<span> </span>中才能开启群聊自动回复。如果想对所有群聊生效,可以直接填写 "group_name_white_list": ["ALL_GROUP"]
  • 默认只要被人 @ 就会触发机器人自动回复;另外群聊天中只要检测到以 "@bot" 开头的内容,同样会自动回复(方便自己触发),这对应配置项 group_chat_prefix
  • 可选配置: group_name_keyword_white_list配置项支持模糊匹配群名称,group_chat_keyword配置项则支持模糊匹配群消息内容,用法与上述两个配置项相同。
  • group_chat_in_one_session:使群聊共享一个会话上下文,配置 ["ALL_GROUP"] 则作用于所有群聊

3.语音识别

  • 添加 "speech_recognition": true 将开启语音识别,默认使用openai的whisper模型识别为文字,同时以文字回复,该参数仅支持私聊 (注意由于语音消息无法匹配前缀,一旦开启将对所有语音自动回复,支持语音触发画图);
  • 添加 "group_speech_recognition": true 将开启群组语音识别,默认使用openai的whisper模型识别为文字,同时以文字回复,参数仅支持群聊 (会匹配group_chat_prefix和group_chat_keyword, 支持语音触发画图);
  • 添加 "voice_reply_voice": true 将开启语音回复语音(同时作用于私聊和群聊),但是需要配置对应语音合成平台的key,由于itchat协议的限制,只能发送语音mp3文件,若使用wechaty则回复的是微信语音。

4.其他配置

  • model: 模型名称,目前支持 gpt-3.5-turbo, text-davinci-003, gpt-4, gpt-4-32k (其中gpt-4 api暂未完全开放,申请通过后可使用)
  • temperature,frequency_penalty,presence_penalty: Chat API接口参数,详情参考OpenAI官方文档。
  • proxy:由于目前 openai 接口国内无法访问,需配置代理客户端的地址,详情参考 #351
  • 对于图像生成,在满足个人或群组触发条件外,还需要额外的关键词前缀来触发,对应配置 image_create_prefix
  • 关于OpenAI对话及图片接口的参数配置(内容自由度、回复字数限制、图片大小等),可以参考 对话接口图像接口 文档,在config.py中检查哪些参数在本项目中是可配置的。
  • conversation_max_tokens:表示能够记忆的上下文最大字数(一问一答为一组对话,如果累积的对话字数超出限制,就会优先移除最早的一组对话)
  • rate_limit_chatgptrate_limit_dalle:每分钟最高问答速率、画图速率,超速后排队按序处理。
  • clear_memory_commands: 对话内指令,主动清空前文记忆,字符串数组可自定义指令别名。
  • hot_reload: 程序退出后,暂存微信扫码状态,默认关闭。
  • character_desc 配置中保存着你对机器人说的一段话,他会记住这段话并作为他的设定,你可以为他定制任何人格 (关于会话上下文的更多内容参考该 issue)
  • subscribe_msg:订阅消息,公众号和企业微信channel中请填写,当被订阅时会自动回复, 可使用特殊占位符。目前支持的占位符有{trigger_prefix},在程序中它会自动替换成bot的触发词。

附:参考文章

WildCard开通ChatGPT4

WildCard充值OpenAI API,并使用GPT-4

Docker-Compose 简明教程