From 96b76746449af81945a37214076da42c61840b77 Mon Sep 17 00:00:00 2001
From: Rock Chin <1010553892@qq.com>
Date: Sun, 19 Feb 2023 11:55:16 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E5=9C=A8=E9=A6=96=E9=A1=B5=E5=B1=95?=
=?UTF-8?q?=E7=A4=BA=E5=8A=9F=E8=83=BD=E7=82=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 88 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 71cbab34..e0c035b3 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,94 @@
## ✅功能
-查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E5%8A%9F%E8%83%BD%E7%82%B9%E5%88%97%E4%B8%BE)
+
+✅回复符合上下文
+
+ - 程序向模型发送近几次对话内容，模型根据上下文生成回复
+ - 您可在`config.py`中修改`prompt_submit_length`自定义联系上下文的范围
+
+
+
+
+✅支持敏感词过滤，避免账号风险
+
+ - 难以监测机器人与用户对话时的内容，故引入此功能以减少机器人风险
+ - 编辑`sensitive.json`，并在`config.py`中修改`sensitive_word_filter`的值以开启此功能
+
+
+
+
+✅群内多种响应规则，不必at
+
+ - 默认回复`ai`作为前缀或`@`机器人的消息
+ - 详细见`config.py`中的`response_rules`字段
+
+
+
+✅使用官方api，不需要网络代理，稳定快捷
+
+ - 不使用ChatGPT逆向接口，而使用官方的Completion API，稳定性高
+ - 您可以在`config.py`中自定义`completion_api_params`字段，设置向官方API提交的参数以自定义机器人的风格
+
+
+
+
+✅完善的多api-key管理，超额自动切换
+
+ - 支持配置多个`api-key`，内部统计使用量并在超额时自动切换
+ - 请在`config.py`中修改`openai_config`的值以设置`api-key`
+ - 可以在`config.py`中修改`api_key_fee_threshold`来自定义切换阈值
+ - 运行期间向机器人说`!usage`以查看当前使用情况
+
+
+
+✅组件少，部署方便，提供一键安装器及Docker安装
+
+ - 手动部署步骤少
+ - 提供自动安装器及docker方式，详见以下安装步骤
+
+
+
+✅支持预设指令文字
+
+ - 支持以自然语言预设文字，自定义机器人人格等信息
+ - 详见`config.py`中的`default_prompt`部分
+ - 支持设置多个预设情景，并通过!reset、!default等指令控制，详细请查看[wiki指令](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4)
+
+
+
+✅完善的会话管理，重启不丢失
+
+ - 使用SQLite进行会话内容持久化
+ - 最后一次对话一定时间后自动保存，请到`config.py`中修改`session_expire_time`的值以自定义时间
+ - 运行期间可使用`!reset` `!list` `!last` `!next` `!prompt`等指令管理会话
+
+
+✅支持对话、绘图等模型，可玩性更高
+
+ - 现已支持OpenAI的对话`Completion API`和绘图`Image API`
+ - 向机器人发送指令`!draw `即可使用绘图模型
+
+
+✅支持指令控制热重载、热更新
+
+ - 允许在运行期间修改`config.py`或其他代码后，以管理员账号向机器人发送指令`!reload`进行热重载，无需重启
+ - 运行期间允许以管理员账号向机器人发送指令`!update`进行热更新，拉取远程最新代码并执行热重载
+
+
+✅支持插件加载🧩
+
+ - 自行实现插件加载器及相关支持
+ - 详细查看[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8)
+
+
+✅私聊、群聊黑名单机制
+
+ - 支持将人或群聊加入黑名单以忽略其消息
+ - 详见Wiki`加入黑名单`节
+
+
+详情请查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E5%8A%9F%E8%83%BD%E7%82%B9%E5%88%97%E4%B8%BE)
## 🔩部署