简介
- 文本对话: 接收私聊及群组中的微信消息,使用ChatGPT生成回复内容,完成自动回复
- 规则定制化: 支持私聊中按指定规则触发自动回复,支持对群组设置自动回复白名单
- 多账号: 支持多微信账号同时运行
- 图片生成: 支持根据描述生成图片,并自动发送至个人聊天或群聊
- 上下文记忆:支持多轮对话记忆,且为每个好友维护独立的上下会话
- 语音识别: 支持接收和处理语音消息,通过文字或语音回复
- 插件化: 支持个性化功能插件,提供角色扮演、文字冒险游戏等预设插件
更新日志
使用效果
个人聊天

群组聊天

图片生成

快速开始
准备
1. OpenAI账号注册
1.1 ChapGPT service On Azure
一种替换以上的方法是使用Azure推出的ChatGPT service。它host在公有云Azure上,因此不需要VPN就可以直接访问。不过目前仍然处于preview阶段。新用户可以通过Try Azure for free来薅一段时间的羊毛
2.运行环境
支持 Linux、MacOS、Windows 系统(可在Linux服务器上长期运行),同时需安装
Python
。(1) 克隆项目代码:
(2) 安装核心依赖 (必选):
其中
tiktoken
要求python
版本在3.8以上,它用于精确计算会话使用的tokens数量,可以不装但建议安装。(3) 拓展依赖 (可选):
使用
google
或baidu
语音识别需安装ffmpeg
,默认的
openai
语音识别不需要安装ffmpeg
。参考#415
配置
配置文件的模板在根目录的
config-template.json
中,需复制该模板创建最终生效的 config.json
文件:然后在
config.json
中填入配置,以下是对默认配置的说明,可根据需要进行自定义修改:配置说明:
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
配置项则支持模糊匹配群消息内容,用法与上述两个配置项相同。(Contributed by evolay)
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
conversation_max_tokens
:表示能够记忆的上下文最大字数(一问一答为一组对话,如果累积的对话字数超出限制,就会优先移除最早的一组对话)
rate_limit_chatgpt
,rate_limit_dalle
:每分钟最高问答速率、画图速率,超速后排队按序处理。
clear_memory_commands
: 对话内指令,主动清空前文记忆,字符串数组可自定义指令别名。
hot_reload
: 程序退出后,暂存微信扫码状态,默认关闭。
character_desc
配置中保存着你对机器人说的一段话,他会记住这段话并作为他的设定,你可以为他定制任何人格 (关于会话上下文的更多内容参考该 issue)
所有可选的配置项均在该文件中列出。
运行
1.本地运行
如果是开发机 本地运行,直接在项目根目录下执行:
终端输出二维码后,使用微信进行扫码,当输出 "Start auto replying" 时表示自动回复程序已经成功运行了(注意:用于登录的微信需要在支付处已完成实名认证)。扫码登录后你的账号就成为机器人了,可以在微信手机端通过配置的关键词触发自动回复 (任意好友发送消息给你,或是自己发消息给好友),参考#142。
2.服务器部署
使用nohup命令在后台运行程序:
扫码登录后程序即可运行于服务器后台,此时可通过
ctrl+c
关闭日志,不会影响后台程序的运行。使用 ps -ef | grep app.py | grep -v grep
命令可查看运行于后台的进程,如果想要重新启动程序可以先 kill
掉对应的进程。日志关闭后如果想要再次打开只需输入 tail -f nohup.out
。此外,scripts
目录下有一键运行、关闭程序的脚本供使用。3.Docker部署
4. Railway部署(推荐)

- 进入 Railway。
- 点击
Deploy Now
按钮。
- 设置环境变量来重载程序运行的参数,例如
open_ai_api_key
,character_desc
。