1、克隆项目到本地
项目地址:https://github.com/kexiaohua-15/chatgpt-on-wechat
git clone https://github.com/kexiaohua-15/chatgpt-on-wechat #克隆项目代码本地
报错:
解决:yum install git -y
2、更新软件,安装项目包
cd chatgpt-on-wechat/ #进入到chatgpt-on-wechat目录
source activate base
sudo yum update #读取软件列表
sudo yum upgrade #更新软件
sudo yum install python3-pip
pip3 install itchat-uos==1.5.0.dev0
pip3 install --upgrade openai
3、配置文件
cp config-template.json config.json
vi config.json
在config.json中填入配置,以下是对默认配置的说明,可根据需要进行自定义修改:
# config.json文件内容示例
{"open_ai_api_key": "YOUR API KEY", # 填入上面创建的 OpenAI API KEY"model": "gpt-3.5-turbo", # 模型名称。当use_azure_chatgpt为true时,其名称为Azure上model deployment名称"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"], # 开启自动回复的群名称列表"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 查看详细指令。"
}
配置说明:
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
- 关于OpenAI对话及图片接口的参数配置(内容自由度、回复字数限制、图片大小等),可以参考 对话接口 和 图像接口 文档,在config.py中检查哪些参数在本项目中是可配置的。
conversation_max_tokens
:表示能够记忆的上下文最大字数(一问一答为一组对话,如果累积的对话字数超出限制,就会优先移除最早的一组对话)rate_limit_chatgpt
,rate_limit_dalle
:每分钟最高问答速率、画图速率,超速后排队按序处理。clear_memory_commands
: 对话内指令,主动清空前文记忆,字符串数组可自定义指令别名。hot_reload
: 程序退出后,暂存微信扫码状态,默认关闭。character_desc
配置中保存着你对机器人说的一段话,他会记住这段话并作为他的设定,你可以为他定制任何人格 (关于会话上下文的更多内容参考该 issue)subscribe_msg
:订阅消息,公众号和企业微信channel中请填写,当被订阅时会自动回复, 可使用特殊占位符。目前支持的占位符有{trigger_prefix},在程序中它会自动替换成bot的触发词。
在以下网址获取key:国外:https://platform.openai.com/account/api-keys
国内:首页 | 佩奇GPT商店 (peiqishop.me)
4、运行
本地运行
#本地测试运行
python3 app.py
报错:
安装:qrcode
模块
pip install qrcode
重新运行并出现一个二维码并用微信扫码登录
5、发@bot 你好
查看终端:发现响应缓慢
[WARNING][2023-07-26 11:04:30][wechat_message.py:68] - [WX]get other_user_id failed: 'NickName'
[INFO][2023-07-26 11:04:31][bridge.py:32] - create bot chatGPT for chat
[INFO][2023-07-26 11:04:31][chat_gpt_bot.py:49] - [CHATGPT] query=你好
最后出现:
[WARNING][2023-07-26 12:55:46][chat_gpt_bot.py:150] - [CHATGPT] APIConnectionError: Error communicating with OpenAI: HTTPSConnectionPool(host='api.openai.com', port=443): Max retries exceeded with url: /v1/chat/completions (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f2569217d90>: Failed to establish a new connection: [Errno 101] Network is unreachable'))
[INFO][2023-07-26 12:55:46][wechat_channel.py:186] - [WX] sendMsg=Reply(type=ERROR, content=[ERROR]
我连接不到你的网络), receiver=filehelper
原因是国内不能访问api.openai.com
微信手机端会出现
6、解决国内不能访问api.openai.com
vi config.json
将config.json改成:
{"open_ai_api_key": "your key","model": "gpt-3.5-turbo","proxy": "","open_ai_api_base": "https://api.chatanywhere.cn/v1","hot_reload": false,"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": ["画","看","找"],"speech_recognition": false,"group_speech_recognition": false,"voice_reply_voice": false,"conversation_max_tokens": 1000,"expires_in_seconds": 3600,"character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题,并且可以使用多种语言与人交流。","subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输入。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持tool、角色扮演和文字冒险等丰富的插件。\n输入{trigger_prefix}#help 查看详细指令。","use_linkai": false,"linkai_api_key": "","linkai_app_code": ""
在首页 | 佩奇GPT商店 (peiqishop.me)购买key:
在https://api.chatanywhere.cn/查看用量:
7、重新执行python3 app.py
成功:
服务端:
[INFO][2023-07-26 13:10:12][chat_gpt_bot.py:49] - [CHATGPT] query=你好
[INFO][2023-07-26 13:10:14][wechat_channel.py:183] - [WX] sendMsg=Reply(type=TEXT, content=[bot] 你好!有什么我可以帮助你的吗?), receiver=filehelpe
微信端:
8、服务器部署
使用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
。此外,scripts
目录下有一键运行、关闭程序的脚本供使用。
多账号支持: 将项目复制多份,分别启动程序,用不同账号扫码登录即可实现同时运行。
特殊指令: 用户向机器人发送 #reset 即可清空该用户的上下文记忆。