简介

本项目仅支持Windows系统运行，<u>基于chatgpt-on-wechat项目二次开发，完全使用了原项目的框架，在此表示感谢！</u>支持Windows平台的PC客户端和企业微信客户端，本项目将持续更新，并逐步开发插件。由个人开发，请勿催促，感谢理解！

项目支持的消息通道及功能如下：

Wework：PC端企业微信个人号消息通道，依赖 ntwork，限制使用WeCom_4.0.8.6027版本，仅支持在Windows平台运行项目。
- 发送消息：文本/图片/视频/文件/群聊@/链接卡片/GIF
- 接收消息：全部类型
- 不足之处：无法发送语音消息
Wechat：PC端微信个人号消息通道，依赖 ntchat项目，最高支持Python 3.10环境版本，限制使用WeChat 3.6.0.18版本，仅支持在Windows平台运行项目。
- 发送消息：文本/图片/视频/文件/群聊@/链接卡片/GIF
- 接收消息：全部类型
- 其他功能：同意好友请求/创建群聊/添加好友入群/邀请好友入群/删除群成员/修改群名称/修改群公告
- 不足之处：无法发送语音消息

详细功能列表：

聊天对话：支持私聊和群聊对话，可使用FastGPT、OpenAI、Azure、文心一言等对话模型通道
语音对话：支持语音消息，可选择文字或语音回复，支持Azure、OpenAI等语音模型，语音回复仅支持文件格式，WeWork客户端可实现语音条回复
绘画插件：默认支持OpenAI绘画，集成MJ绘画插件，待海艺开放API后将优先接入并适配
联网插件：内置联网插件，通过GPT的函数调用功能实现，目前可用，持续优化中
高度定制：依赖FastGPT接口，可实现每个群聊对应不同的应用知识库

更新日志

2023.08.15： 更新FastGPT接入逻辑，支持单群单知识库，未配置时默认使用全局base。
 {
     "fast_gpt": true,
     "fastgpt_list": {
       "R:108864****63985": "fastgpt-1aps*****pg47-64b16a*******181317",
       "R:107******373863": "fastgpt-1aps8*****gni1kpg47-64b168*****cd181267"
   	}
 }
2023.08.08： 添加Wework（企业微信个人号）消息通道。

2023.07.25： 添加WeChat消息通道，项目兼容FastGPT API接口，直接修改open_ai_api_key和open_ai_api_base即可使用。

快速开始

准备工作

1. 运行环境

仅支持Windows系统，同时需要安装Python。

建议Python版本在3.7.1到3.10之间。

(1) 下载项目代码：

git clone https://github.com/chazzjimel/WeChat-AIChatbot-WinOnly
cd chatgpt-on-wechat/

(2) 安装核心依赖（必选）：

pip3 install -r requirements.txt

(3) 安装拓展依赖（可选，建议安装）：

pip3 install -r requirements-optional.txt

如果某项依赖安装失败，请将对应行注释掉后继续。

其中tiktoken要求Python版本在3.8以上，它用于精确计算会话使用的tokens数量，强烈建议安装。

使用Google或Baidu语音识别需要安装ffmpeg，

默认的OpenAI语音识别不需要安装ffmpeg。

参考#415

使用Azure语音功能需要安装依赖，并参考文档的环境要求：

pip3 install azure-cognitiveservices-speech

配置

配置文件模板位于根目录的config-template.json中，需要复制该模板创建最终生效的config.json文件：

cp config-template.json config.json

然后在config.json中填入配置，以下是对默认配置的说明，可根据需要进行自定义修改（请删除注释）：

# config.json文件内容示例
{
  "open_ai_api_key": "你的API密钥",                           # 填入上面创建的 OpenAI API 密钥
  "model": "gpt-3.5-turbo",                                   # 模型名称。当use_azure_chatgpt为true时，其名称为Azure上模型部署名称
  "proxy": "",                                                # 代理客户端的IP和端口，国内环境开启代理的需要填写该项，如 "127.0.0.1:7890"
  "single_chat_prefix": ["机器人", "@机器人"],                  # 私聊时文本需要包含该前缀才能触发机器人回复
  "single_chat_reply_prefix": "[机器人] ",                     # 私聊时自动回复的前缀，用于区分真人
  "group_chat_prefix": ["@机器人"],                            # 群聊时包含该前缀则会触发机器人回复
  "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服务代替OpenAI ChatGPT服务。当设置为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}，在程序中它会自动替换成机器人的触发词。
  "subscribe_msg": "感谢您的关注！\n这里是ChatGPT，可以自由对话。\n支持语音对话。\n支持图片输出，画字开头的消息将按要求创作图片。\n支持角色扮演和文字冒险等丰富插件。\n输入{trigger_prefix}#help 查看详细指令。",
  "accept_friend": false,                                     # 配置itchat和ntchat自动通过好友请求
  "channel_type": "wx",                                       # 通道类型，支持：{ntchat,wework,weowrktop}
  "fast_gpt": false,                                          # 标识模型接口是否是fastgpt
  "ntchat_smart": false,                                      # 配置ntchat多开，为true时接管当前已登录微信，默认true
  "wework_smart": false,                                      # 配置wework多开，为true时接管当前已登录企业微信，默认true
  "fastgpt_list": {
        "R:108864****63985": "fastgpt-1aps*****pg47-64b16a*******181317",
        "R:107******373863": "fastgpt-1aps8*****gni1kpg47-64b168*****cd181267"
    },                                                        # 每个群聊ID配置对应的key即可实现单群单知识库，未配置的默认
  "wework_http": "http://127.0.0.1:8000",                     # weworktop通道http接口地址，默认127.0.0.1:8000
  "wework_callback_port": 8001,                               # weworktop回调端口
  "voice_openai_api_key": "",                                 # 使用了fastgpt仍然有openai语音识别需求的，要在这里配置一下openai的参数
  "voice_openai_api_base": "",                                # 使用了fastgpt仍然有openai语音识别需求的，要在这里配置一下openai的参数
 }

配置说明：

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配置项则支持模糊匹配群消息内容，用法与上述两个配置项相同。（由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将开启语音回复语音（同时作用于私聊和群聊），但是需要配置对应语音合成平台的密钥，由于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的触发词。