项目介绍：

基于大模型搭建的聊天机器人。

  • 支持平台：企业微信、微信 公众号、飞书、钉钉 等接入
  • 支持模型：GPT3.5/GPT4.0/Claude/文心一言/讯飞星火/通义千问/Gemini/GLM-4/Claude/LinkAI，
  • 支持能力：处理文本、语音和图片，访问操作系统和互联网
  • 支持知识库：基于自有知识库进行定制企业智能客服（基于 LinkAI 实现）。
  • 支持插件：基于插件系统、LinkAI 等

准备工作：

  • 需要OpenAI账号（需要外网环境）并获取 API key。
  • 需要 Link-AI 账号（不需要外网环境）并获取 API key。
  • 服务器一台，Linux或者Windows都可。

安装：

这里以Linux环境安装，基于centos7.6，Windows安装方法大同小异

运行环境 需要python3

  1. 首先检测自己的机器的python3版本，程序要求python3.7.1~3.9.X 之间，这里推荐python3.8
python3
  • 确认python3版本是否在3.7.1~3.9.X 之间
    05260236
  • 如果返回”-bash: python3: command not found“则代表服务器没有安装python3，需要安装
  • 安装python3.8环境可以参考 这里

拉取程序，需要使用git拉取

  1. 安装git
sudo yum install git -y
  1. git拉取chatgpt-on-wechat项目，并切换到项目主目录。
git clone https://github.com/zhayujie/chatgpt-on-wechat
cd chatgpt-on-wechat/

安装依赖

pip3 install -r requirements.txt                # 必选依赖
pip3 install -r requirements-optional.txt       # 可选依赖，语音、tool插件等功能需要
  • 如果某项依赖安装失败请注释掉对应的行再继续。
  • 其中tiktoken要求python版本在3.8以上，它用于精确计算会话使用的tokens数量，强烈建议安装。
  • 使用google或baidu语音识别需安装ffmpeg，
  • 默认的openai语音识别不需要安装ffmpeg。

配置：

  • 配置文件的模板在根目录的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
  "model": "gpt-3.5-turbo",                                   # 模型名称, 支持 gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, wenxin, xunfei
  "proxy": "",                                                # 代理客户端的ip和端口，国内环境开启代理的需要填写该项，如 "127.0.0.1:7890"
  "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时，模型部署名称
  "azure_api_version": "",                                    # 采用Azure ChatGPT时，API版本
  "character_desc": "你是ChatGPT, 一个由OpenAI训练的大型语言模型, 你旨在回答并解决人们的任何问题，并且可以使用多种语言与人交流。",  # 人格描述
  # 订阅消息，公众号和企业微信channel中请填写，当被订阅时会自动回复，可使用特殊占位符。目前支持的占位符有{trigger_prefix}，在程序中它会自动替换成bot的触发词。
  "subscribe_msg": "感谢您的关注！\n这里是ChatGPT，可以自由对话。\n支持语音对话。\n支持图片输出，画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。",
  "use_linkai": false,                                        # 是否使用LinkAI接口，默认关闭，开启后可国内访问，使用知识库和MJ
  "linkai_api_key": "",                                       # LinkAI Api Key
  "linkai_app_code": ""                                       # LinkAI 应用code
}

配置说明：

  1. 个人聊天
  • 个人聊天中，需要以 “bot"或”@bot" 为开头的内容触发机器人，对应配置项 single_chat_prefix (如果不需要以前缀触发可以填写 “single_chat_prefix”: [“”])
  • 机器人回复的内容会以 "[bot] " 作为前缀， 以区分真人，对应的配置项为 single_chat_reply_prefix (如果不需要前缀可以填写 “single_chat_reply_prefix”: “”)
  1. 群组聊天
  • 群组聊天中，群名称需配置在 group_name_white_list 中才能开启群聊自动回复。如果想对所有群聊生效，可以直接填写 “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”] 则作用于所有群聊
  1. 语音识别
  • 添加 “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则回复的是微信语音。
  1. 其他配置
  • 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 接口国内无法访问，需配置代理客户端的地址，详情参考
  • 对于图像生成，在满足个人或群组触发条件外，还需要额外的关键词前缀来触发，对应配置 image_create_prefix
  • 关于OpenAI对话及图片接口的参数配置（内容自由度、回复字数限制、图片大小等），可以参考对话接口和图像接口 文档，在config.py中检查哪些参数在本项目中是可配置的。
  • conversation_max_tokens：表示能够记忆的上下文最大字数（一问一答为一组对话，如果累积的对话字数超出限制，就会优先移除最早的一组对话）
  • rate_limit_chatgpt，rate_limit_dalle：每分钟最高问答速率、画图速率，超速后排队按序处理。
  • clear_memory_commands: 对话内指令，主动清空前文记忆，字符串数组可自定义指令别名。
  • hot_reload: 程序退出后，暂存微信扫码状态，默认关闭。
  • character_desc 配置中保存着你对机器人说的一段话，他会记住这段话并作为他的设定，你可以为他定制任何人格 (关于会话上下文的更多内容参考)
  • subscribe_msg：订阅消息，公众号和企业微信channel中请填写，当被订阅时会自动回复， 可使用特殊占位符。目前支持的占位符有{trigger_prefix}，在程序中它会自动替换成bot的触发词。
  1. LinkAI配置 (可选)
  • use_linkai: 是否使用LinkAI接口，开启后可国内访问，使用知识库和 Midjourney 绘画, 参考文档
  • linkai_api_key: LinkAI Api Key，可在 控制台 创建
  • linkai_app_code: LinkAI 应用code，选填

运行程序：

使用nohup命令在后台运行程序，即使断开ssh连接也能保持运行：

touch nohup.out                                   # 首次运行需要新建日志文件  
nohup python3 app.py & tail -f nohup.out          # 在后台运行程序并通过日志输出二维码

扫码登录后程序即可运行于服务器后台，此时可通过 ctrl+c 关闭日志，不会影响后台程序的运行。在日志关闭后如果想要再次打开只需输入 tail -f nohup.out。
此外，scripts 目录下有一键运行、关闭程序的脚本供使用。

停止程序:

如果想要关闭程序可以 执行 kill -pid 来完成，执行以下命令可以查看当前进程的 pid：

ps -ef | grep app.py | grep -v grep

多账号支持： 将项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。
特殊指令： 用户向机器人发送 #reset 即可清空该用户的上下文记忆。

最后效果:

05260242