QChatGPT/README.md

QChatGPT🤖

2023/3/18 现已支持GPT-4 API（内测），请查看config-template.py中的completion_api_params
2023/3/15 逆向库已支持New Bing，使用方法查看插件文档
2023/3/15 逆向库已支持GPT-4模型，使用方法查看插件
2023/3/3 现已在主线支持官方ChatGPT接口，使用方法查看#195

• 到项目Wiki可了解项目详细信息
• 由bilibili TheLazy制作的视频教程（寄了，求大佬做个新的）
• 交流、答疑群: 204785790（已满）、691226829（已满）、656285629
  • 进群提问前请您确保已经找遍文档和issue均无法解决
• QQ频道机器人见QQChannelChatGPT

通过调用OpenAI的ChatGPT等语言模型来实现一个更加智能的QQ机器人

🍺模型适配一览

点击此处展开

文字对话

• OpenAI GPT-3.5模型(ChatGPT API), 本项目原生支持, 默认使用
• OpenAI GPT-3模型, 本项目原生支持, 部署完成后前往config.py切换
• OpenAI GPT-4模型, 本项目原生支持, 目前需要您的账户通过OpenAI的内测申请, 请前往config.py切换
• ChatGPT网页版GPT-3.5模型, 由插件接入
• ChatGPT网页版GPT-4模型, 目前需要ChatGPT Plus订阅, 由插件接入
• New Bing逆向库, 由插件接入

故事续写

• NovelAI API, 由插件接入

图片绘制

• OpenAI DALL·E模型, 本项目原生支持, 使用方法查看Wiki功能使用页
• NovelAI API, 由插件接入

语音生成

• TTS+VITS, 由插件接入
• Plachta/VITS-Umamusume-voice-synthesizer, 由插件接入

✅功能

✅支持敏感词过滤，避免账号风险

• 难以监测机器人与用户对话时的内容，故引入此功能以减少机器人风险
• 加入了百度云内容审核，在config.py中修改baidu_check的值，并填写baidu_api_key和baidu_secret_key以开启此功能
• 编辑sensitive.json，并在config.py中修改sensitive_word_filter的值以开启此功能

✅群内多种响应规则，不必at

• 默认回复ai作为前缀或@机器人的消息
• 详细见config.py中的response_rules字段

✅完善的多api-key管理，超额自动切换

• 支持配置多个api-key，内部统计使用量并在超额时自动切换
• 请在config.py中修改openai_config的值以设置api-key
• 可以在config.py中修改api_key_fee_threshold来自定义切换阈值
• 运行期间向机器人说!usage以查看当前使用情况

✅支持预设指令文字

• 支持以自然语言预设文字，自定义机器人人格等信息
• 详见config.py中的default_prompt部分
• 支持设置多个预设情景，并通过!reset、!default等指令控制，详细请查看wiki指令

✅支持对话、绘图等模型，可玩性更高

• 现已支持OpenAI的对话Completion API和绘图Image API
• 向机器人发送指令!draw <prompt>即可使用绘图模型

✅支持指令控制热重载、热更新

• 允许在运行期间修改config.py或其他代码后，以管理员账号向机器人发送指令!reload进行热重载，无需重启
• 运行期间允许以管理员账号向机器人发送指令!update进行热更新，拉取远程最新代码并执行热重载

✅支持插件加载🧩

• 自行实现插件加载器及相关支持
• 详细查看插件使用页

✅私聊、群聊黑名单机制

• 支持将人或群聊加入黑名单以忽略其消息
• 详见Wiki加入黑名单节

✅长消息处理策略

• 支持将长消息转换成图片或消息记录组件，避免消息刷屏
• 请查看config.py中blob_message_strategy等字段

✅回复速度限制

• 支持限制单会话内每分钟可进行的对话次数
• 具有“等待”和“丢弃”两种策略
  • “等待”策略：在获取到回复后，等待直到此次响应时间达到对话响应时间均值
  • “丢弃”策略：此分钟内对话次数达到限制时，丢弃之后的对话
• 详细请查看config.py中的相关配置

✅支持使用网络代理

• 目前已支持正向代理访问接口
• 详细请查看config.py中的openai_config的说明

详情请查看Wiki功能使用页

🔩部署

部署过程中遇到任何问题，请先在QChatGPT或qcg-installer的issue里进行搜索

❗部署完成后必看: 指令说明❗

- 注册OpenAI账号

若您要直接使用非OpenAI的模型（如New Bing），可跳过此步骤，直接进行之后的部署，完成后按照相关插件的文档进行配置即可

参考以下文章自行注册

国内注册ChatGPT的方法(100%可用)
手把手教你如何注册ChatGPT，超级详细

注册成功后请前往个人中心查看api_key
完成注册后，使用以下自动化或手动部署步骤

- 自动化部署

展开查看，以下方式二选一，Linux首选Docker，Windows首选安装器

Docker方式

请查看此仓库mikumifa/QChatGPT-Docker-Installer

安装器方式

使用此安装器（若无法访问请到Gitee）进行部署

• 安装器目前仅支持部分平台，请到仓库文档查看，其他平台请手动部署

- 手动部署

手动部署适用于所有平台

• 请使用Python 3.9.x以上版本

配置Mirai

按照此教程配置Mirai及YiriMirai
启动mirai-console后，使用login命令登录QQ账号，保持mirai-console运行状态

配置主程序

1. 克隆此项目

git clone https://github.com/RockChinQ/QChatGPT
cd QChatGPT

2. 安装依赖

pip3 install yiri-mirai openai colorlog func_timeout dulwich Pillow

3. 运行一次主程序，生成配置文件

python3 main.py

4. 编辑配置文件config.py

按照文件内注释填写配置信息

5. 运行主程序

python3 main.py

无报错信息即为运行成功

常见问题

• mirai登录提示QQ版本过低，见此issue
• 如提示安装uvicorn或hypercorn请不要安装，这两个不是必需的，目前存在未知原因bug
• 如报错TypeError: As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary, 请参考 此处

🚀使用

查看Wiki功能使用页

🧩插件生态

现已支持自行开发插件对功能进行扩展或自定义程序行为
详见Wiki插件使用页
开发教程见Wiki插件开发页

查看插件列表

示例插件

在tests/plugin_examples目录下，将其整个目录复制到plugins目录下即可使用

• cmdcn - 主程序指令中文形式
• hello_plugin - 在收到消息hello时回复相应消息
• urlikethisijustsix - 收到冒犯性消息时回复相应消息

更多

欢迎提交新的插件

• revLibs - 将ChatGPT网页版接入此项目，关于官方接口和网页版有什么区别
• hello_plugin - hello_plugin 的储存库形式，插件开发模板
• dominoar/QChatPlugins - dominoar编写的诸多新功能插件（语音输出、Ranimg、屏蔽词规则等）
• dominoar/QCP-NovelAi - NovelAI 故事叙述与绘画
• oliverkirk-sudo/chat_voice - 文字转语音输出，使用HuggingFace上的VITS-Umamusume-voice-synthesizer模型
• RockChinQ/WaitYiYan - 实时获取百度文心一言等待列表人数
• QChartGPT_Emoticon_Plugin - 使机器人根据回复内容发送表情包

😘致谢

• @the-lazy-me 为本项目制作视频教程
• @mikumifa 本项目Docker部署仓库开发者
• @dominoar 为本项目开发多种插件
• @万神的星空 整合包发行
• @ljcduo GPT-4 API内测账号提供

以及所有贡献者和其他为本项目提供支持的朋友们。