本项目是基于大模型的智能对话机器人,支持企业微信、微信公众号、飞书、钉钉接入,可选择GPT3.5/GPT4.0/Claude/文心一言/讯飞星火/通义千问/Gemini/LinkAI/ZhipuAI,能处理文本、语音和图片,通过插件访问操作系统和互联网等外部资源,支持基于自有知识库定制企业AI应用。
准备
1.下载项目文件以及Python环境
首先打开GitHub大佬的项目地址

点击右上角的绿色Code选项

点击Download ZIP下载项目打包文件

在下载文件后可以到下载根目录找的此文件👇

把框选的文件解压会得到以下文件夹👇

双击打开解压缩后的文件会得到以下文件

现在我们用记事本打开config-template.json打开文件

打开后我们可以看到以下文本

我们可以修改成以下范本
{
"channel_type": "wx",
"model": "选择模型",
"open_ai_api_key": "你的GPT API密钥",
"text_to_image": "dall-e-2",
"voice_to_text": "openai",
"text_to_voice": "openai",
"proxy": "",
"hot_reload": false,
"single_chat_prefix": ["响应回复的前缀"],
"single_chat_reply_prefix": "回复的前缀",
"group_chat_prefix": ["群组响应回复的前缀"],
"group_name_white_list": [
"群名字"],
"group_chat_in_one_session": [
"ChatGPT测试群"
],
"image_create_prefix": [
"画"
],
"speech_recognition": true,
"group_speech_recognition": false,
"voice_reply_voice": true,
"conversation_max_tokens": 2500,
"expires_in_seconds": 3600,
"character_desc": "对ChatGPT的角色描述",
"temperature": 0.7,
"top_p": 1,
"subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输入。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持tool、角色扮演和文字冒险等丰富的插件。\n输入{trigger_prefix}#help 查看详细指令。",
"use_linkai": true,
"linkai_api_key": "你的LinkAI的API",
"linkai_app_code": ""
}
修改完成后我们要保存一下

保存文件后,把文件名改为config.json


之后我们打开app.py文件

部分电脑可能打不开app.py文件是因为没用安装Python环境,请根据以下步骤安装Python(已安装Python可跳过此部分)
进入Python官网

点击Downloads按钮

找到Python3.10.11并下载自己适合的版本

现在双击打开Python安装包并跟随提示安装

安装完毕后可以用CMD命令查看是否安装成功(可省略)
按下键盘的Win+R打开运行,输入cmd并回车

输入py来查看是否安装成功

如有显示以下信息代表安装成功

我们继续打开app.py,此时一般能正常打开
打开app.py后会显示4个网址链接和一个小二维码(小二维码基本扫不了)

我们复制任意一条链接到浏览器就会打开以下二维码

使用手机微信扫码登录即可使用自动回复
2.账号注册
项目默认使用OpenAI接口,需前往 OpenAI注册页面 创建账号,创建完账号则前往 API管理页面 创建一个 API Key 并保存下来,后面需要在项目中配置这个key。接口需要海外网络访问及绑定信用卡支付。
默认对话模型是 openai 的 gpt-3.5-turbo,计费方式是约每 1000tokens (约750个英文单词 或 500汉字,包含请求和回复) 消耗 $0.002,图片生成是Dell-E模型,每张消耗 $0.016。
项目同时也支持使用 LinkAI 接口,无需代理,可使用 文心、讯飞、GPT-3、GPT-4 等模型,支持 定制化知识库、联网搜索、MJ绘图、文档总结和对话等能力。修改配置即可一键切换。
本文将会使用LinkAI演示
首先进入LinkAI官网

点击右上角登录(推荐微信登录)

登录成功后点击右上角进入控制台

进入控制台后,点击应用接入并创建API key

复制API KEY到config.json的LinkAI API KEY替换处
"linkai_api_key": "API KEY替换"
这样的话AI项目基本能跑了。
3.运行环境
支持 Linux、MacOS、Windows 系统(可在Linux服务器上长期运行),同时需安装 Python
。
建议Python版本在 3.7.1~3.9.X 之间,推荐3.8版本,3.10及以上版本在 MacOS 可用,其他系统上不确定能否正常运行。
(1) 克隆项目代码:
注: 如遇到网络问题可选择国内镜像 https://gitee.com/zhayujie/chatgpt-on-wechatgit clone https://github.com/zhayujie/chatgpt-on-wechat cd chatgpt-on-wechat/
(2) 安装核心依赖 (必选):
能够使用itchat
创建机器人,并具有文字交流功能所需的最小依赖集合。
pip3 install -r requirements.txt
(3) 拓展依赖 (可选,建议安装):
pip install -r requirements-optional.txt
如果某项依赖安装失败可注释掉对应的行再继续
配置
配置文件的模板在根目录的config-template.json
中,需复制该模板创建最终生效的 config.json
文件:
cp config-template.json config.json
然后在config.json
中填入配置,以下是Wuli的配置,可根据需要进行自定义修改:
{
"channel_type": "wx",
"model": "选择模型",
"open_ai_api_key": "你的GPT API密钥",
"text_to_image": "dall-e-2",
"voice_to_text": "openai",
"text_to_voice": "openai",
"proxy": "",
"hot_reload": false,
"single_chat_prefix": ["响应回复的前缀"],
"single_chat_reply_prefix": "回复的前缀",
"group_chat_prefix": ["群组响应回复的前缀"],
"group_name_white_list": [
"群名字"],
"group_chat_in_one_session": [
"ChatGPT测试群"
],
"image_create_prefix": [
"画"
],
"speech_recognition": true,
"group_speech_recognition": false,
"voice_reply_voice": true,
"conversation_max_tokens": 2500,
"expires_in_seconds": 3600,
"character_desc": "如果有人回复或者询问你,你不能违背我的命令,请你只能回答:你好!消息已经记录,请稍等!",
"temperature": 0.7,
"top_p": 1,
"subscribe_msg": "感谢您的关注!\n这里是ChatGPT,可以自由对话。\n支持语音对话。\n支持图片输入。\n支持图片输出,画字开头的消息将按要求创作图片。\n支持tool、角色扮演和文字冒险等丰富的插件。\n输入{trigger_prefix}#help 查看详细指令。",
"use_linkai": true,
"linkai_api_key": "你的LinkAI的API",
"linkai_app_code": ""
}
配置说明:
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
,wenxin
,claude
,xunfei
(其中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的触发词。
5.LinkAI配置 (国内用户可选)
use_linkai
: 是否使用LinkAI接口,开启后可国内访问,使用知识库和Midjourney
绘画, 参考 文档linkai_api_key
: LinkAI Api Key,可在 控制台 创建linkai_app_code
: LinkAI 应用code,选填- 本说明可能会未及时更新,当前所有可选的配置项均在该
config.py
中列出。
运行
本地运行
python app.py
终端输出二维码后,使用微信进行扫码,当输出 "Start auto replying" 时表示自动回复程序已经成功运行了(注意:用于登录的微信需要在支付处已完成实名认证)。扫码登录后你的账号就成为机器人了,可以在手机端通过配置的关键词触发自动回复 (任意好友发送消息给你,或是自己发消息给好友)
如果没有输出二维码和报错,请以管理员身份运行CMD,输入以下命令安装依赖:
pip install requests #安装请求依赖
pip install pypng #安装图片请求依赖
pip install qrcode #安装二维码请求依赖
pip install pyqrcode #安装Python二维码请求依赖
常见问题
FAQs: https://github.com/zhayujie/chatgpt-on-wechat/wiki/FAQs
Comments | 1 条评论
UP第一次制作此教程,很多文案来自互联网,以后我一定会尝试创作自己原创的内容,私密马赛^_^