zhayujie fe7b7b18fc docs: update readme doc | 1 year ago | |
---|---|---|
bot | 1 year ago | |
bridge | 1 year ago | |
channel | 1 year ago | |
common | 1 year ago | |
docs/images | 1 year ago | |
.gitignore | 1 year ago | |
LICENSE | 1 year ago | |
README.md | 1 year ago | |
app.py | 1 year ago | |
config-template.json | 1 year ago | |
config.py | 1 year ago |
ChatGPT近期以强大的对话和信息整合能力风靡全网,可以写代码、改论文、讲故事,几乎无所不能,这让人不禁有个大胆的想法,能否用他的对话模型把我们的微信打造成一个智能机器人,可以在与好友对话中给出意想不到的回应,而且再也不用担心女朋友影响我们
打游戏工作了。
基于ChatGPT的微信聊天机器人,通过 OpenAI 接口生成对话内容,使用 itchat 实现微信消息的接收和自动回复。已实现的特性如下:
2022.12.19: 引入 itchat-uos 替换 itchat,解决由于不能登录网页微信而无法使用的问题,且解决Python3.9的兼容问题
2022.12.18: 支持根据描述生成图片并发送,openai版本需大于0.25.0
2022.12.17: 原来的方案是从 ChatGPT页面 获取session_token,使用 revChatGPT 直接访问web接口,但随着ChatGPT接入Cloudflare人机验证,这一方案难以在服务器顺利运行。 所以目前使用的方案是调用 OpenAI 官方提供的 API,回复质量上基本接近于ChatGPT的内容,劣势是暂不支持有上下文记忆的对话,优势是稳定性和响应速度较好。
前往 OpenAI注册页面 创建账号,参考这篇 教程 可以通过虚拟手机号来接收验证码。创建完账号则前往 API管理页面 创建一个 API Key 并保存下来,后面需要在项目中配置这个key。
项目中使用的对话模型是 davinci,计费方式是每1k字 (包含请求和回复) 消耗 $0.02,图片生成是每张消耗 $0.016,账号创建有免费的 $18 额度,使用完可以更换邮箱重新注册。
支持 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_chat_keyword": ["为什么", "why", "Why", "?", "请教"], # 群聊内容包含其中任意字符串,将会触发机器人回复
"group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"], # 开启自动回复的群名称列表
"group_name_keyword_white_list": ["相亲相爱", "瞎侃"], # 开启自动回复的群名称关键字列表(群名称含关键字即可匹配上)
"image_create_prefix": ["画", "看", "找"] # 开启图片回复的前缀
}
配置说明:
1.个人聊天
single_chat_prefix
(如果不需要以前缀触发可以填写 "single_chat_prefix": [""]
)single_chat_reply_prefix
(如果不需要前缀可以填写 "single_chat_reply_prefix": ""
)2.群组聊天
group_name_white_list
中才能开启群聊自动回复。如果想对所有群聊生效,可以直接填写 "group_name_white_list": "ALL_GROUP"
group_chat_prefix
group_name_keyword_white_list
配置项支持模糊匹配群名称,group_chat_keyword
配置项则支持模糊匹配群消息内容,用法与上述两个配置项相同。(Contributed by evolay)3.其他配置
image_create_prefix
bot/openai/open_ai_bot.py
中进行调整。1.如果是开发机 本地运行,直接在项目根目录下执行:
python3 app.py
终端输出二维码后,使用微信进行扫码,当输出 “Start auto replying” 时表示自动回复程序已经成功运行了(注意:用于登录的微信需要在支付处已完成实名认证)。
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
。
FAQs: https://github.com/zhayujie/chatgpt-on-wechat/wiki/FAQs
欢迎提交 PR、Issues。程序运行遇到问题优先查看 常见问题列表 ,其次前往 Issues 中搜索,没有相似问题则创建Issue,一段时间内无回复可加微信 zhayujie_com 交流。