diff --git a/src/.vuepress/navbar.ts b/src/.vuepress/navbar.ts index 79a6687d6..df17ceb45 100644 --- a/src/.vuepress/navbar.ts +++ b/src/.vuepress/navbar.ts @@ -14,6 +14,11 @@ export default navbar([ }, // "/posts/deploy/", // "/posts/Features", + { + text: "配置方法", + icon: "context", + link: "/posts/config-intro", + }, { text: "疑难解答", icon: "discover", diff --git a/src/.vuepress/sidebar.ts b/src/.vuepress/sidebar.ts index 0f6449e7f..9a1e91146 100644 --- a/src/.vuepress/sidebar.ts +++ b/src/.vuepress/sidebar.ts @@ -38,6 +38,11 @@ export default sidebar({ // }, ], }, + { + text: "命令用法", + icon: "command", + link: "posts/command", + }, { text: "配置方法", icon: "context", diff --git a/src/posts/command.md b/src/posts/command.md new file mode 100644 index 000000000..06a097120 --- /dev/null +++ b/src/posts/command.md @@ -0,0 +1,61 @@ +--- +title: QChatGPT的命令讲解 +icon: context +# 这是侧边栏的顺序 +order: 3 +# 设置作者 +author: RockChinQ +# 设置写作时间 +date: 2024-02-13 +category: + - 使用指南 +tag: + - 配置方法 + - 使用指南 +--- + + +:::info 目录 +[[toc]] +::: + + +> `<>` 中的为必填参数,使用时请不要包含`<>` +> `[]` 中的为可选参数,使用时请不要包含`[]` + +以下是默认情况下的权限分类,可以根据下方的命令权限控制进行修改 + +## 用户级别命令 + +> 可以使用`!help`命令来查看命令说明 + +任何对象可使用 + +``` +!help 显示自定义的帮助信息(可在配置文件中更改) +!cmd [命令名称] 显示命令列表或指定命令的详细信息 +!list [页数] 列出本对象的历史会话列表 +!del <序号> 删除指定的历史记录,可以通过 !list 查看序号 +!del all 删除本会话对象的所有历史记录 +!last 切换到前一次会话 +!next 切换到后一次会话 +!reset 重置当前会话 +!prompt 查看当前会话的所有记录 +!version 查看当前版本并检查更新 +!resend 回滚前一次请求 +!plugin 用法请查看插件介绍页的`管理`章节 +!default 查看可用的情景预设值 +``` + +## 管理员命令 + +仅管理员私聊机器人时可使用,必须先在`config.py`中的`admin_qq`设置管理员QQ + +``` +!update 进行程序自动更新 +!default set <情景预设名称> 修改!reset未指定情景预设时的默认情景,详细请查看config.py中default_prompt字段的注释 +``` + +## 命令权限控制 + +您可以编辑`data/config/command.json`来设置命令节点的权限,当命令被发起时,若用户的权限级别(管理员为`2`,普通用户为`1`)大于等于命令节点的权限级别,命令即可被成功执行。具体配置方式请查看配置文件详解页。 \ No newline at end of file diff --git a/src/posts/config-intro.md b/src/posts/config-intro.md index 615d83ca8..cef57d98a 100644 --- a/src/posts/config-intro.md +++ b/src/posts/config-intro.md @@ -2,7 +2,7 @@ title: QChatGPT的详细配置解读 icon: context # 这是侧边栏的顺序 -order: 3 +order: 4 # 设置作者 author: Lazy # 设置写作时间 diff --git a/src/posts/feature.md b/src/posts/feature.md index d290d956f..e5ff123a2 100644 --- a/src/posts/feature.md +++ b/src/posts/feature.md @@ -152,138 +152,3 @@ category: 3. at机器人并发送`!help`查看帮助信息 ![屏幕截图 2](https://cos.thelazy.cn/pictures/qchatgpt%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%BB%8D202312201454898.png) - -### 绘图功能 - -对机器人发送`!draw <图片描述>`即可获得图片,绘图时间较长,请耐心等待。 -绘图功能与对话功能是分离的,机器人对话时并不了解其具有绘画能力。 - -![屏幕截图 3](https://cos.thelazy.cn/pictures/qchatgpt%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%BB%8D202312201454266.png) - -### 机器人命令 - -目前支持的命令 - -> `<>` 中的为必填参数,使用时请不要包含`<>` -> `[]` 中的为可选参数,使用时请不要包含`[]` - -#### 用户级别命令 - -> 可以使用`!help`命令来查看命令说明 - -任何对象可使用 - -``` -!help 显示自定义的帮助信息(可在config.py修改help_message设置) -!cmd [命令名称] 显示命令列表或指定命令的详细信息 -!list [页数] 列出本对象的历史会话列表 -!del <序号> 删除指定的历史记录,可以通过 !list 查看序号 -!del all 删除本会话对象的所有历史记录 -!last 切换到前一次会话 -!next 切换到后一次会话 -!reset [使用预设] 重置对象的当前会话,可指定使用的情景预设值(通过!default命令查看可用的) -!prompt 查看对象当前会话的所有记录 -!usage 查看api-key的使用量 -!draw <提示语> 进行绘图 -!version 查看当前版本并检查更新 -!resend 重新回复上一个问题 -!plugin 用法请查看插件使用页的`管理`章节 -!default 查看可用的情景预设值 -``` - -#### 管理员命令 - -仅管理员私聊机器人时可使用,必须先在`config.py`中的`admin_qq`设置管理员QQ - -``` -!reload 重载程序代码,适用于更新配置文件或更改代码后的热重载 -!update 进行程序自动更新 -!cfg [配置项新值] 运行期间操作配置项,使用方法见下文 -!default set <情景预设名称> 修改!reset未指定情景预设时的默认情景,详细请查看config.py中default_prompt字段的注释 -!delhst <会话名称> 删除指定会话的所有历史记录, 会话名称为 group_群号 或 person_QQ号 -!delhst all 删除所有会话的所有历史记录 -``` -
-⚙ !cfg 命令及其简化形式详解 - -此命令可以在运行期间由管理员通过QQ私聊窗口修改配置信息,**重启之后会失效**。 - -用法: -1. 查看所有配置项及其值 - -``` -!cfg all -``` - -2. 查看某个配置项的值 - -以`default_prompt`示例 -``` -!cfg default_prompt -``` - -输出示例 -``` -[bot]配置项default_prompt: "如果我之后想获取帮助,请你说“输入!help获取帮助”" -``` - -3. 修改某个配置项 - -格式: `!cfg <配置项名称> <配置项新值>` -以修改`default_prompt`示例 -``` -!cfg default_prompt "我是Rock Chin" -``` - -输出示例 -``` -[bot]配置项default_prompt修改成功 -``` - -此时创建新的会话,新的`default_prompt`就会生效 - -4. ⭐此命令的简化形式 - -格式:`!~<配置项名称>` -其中`!~`等价于`!cfg ` -则前述三个命令分别可以简化为: -``` -!~all -!~default_prompt -!~default_prompt "我是Rock Chin" -``` - -5. 配置项名称支持使用点号(.)拼接以索引子配置项 - -例如: `openai_config.api_key`将索引`config`字典中的`openai_config`字典中的`api_key`字段,可以通过这个方式查看或修改此子配置项 - -``` -!~openai_config.api_key -``` - -
- -### 命令权限控制 - -> 我们在[此PR](https://github.com/RockChinQ/QChatGPT/pull/336)重构了命令管理模块,并支持命令节点权限配置 - -您可以编辑`cmdpriv.json`来设置命令节点的权限,当命令被发起时,若用户的权限级别(管理员为`2`,普通用户为`1`)大于等于命令节点的权限级别,命令即可被成功执行。 -示例: -```json -{ - "plugin": 1, - "plugin.get": 2 -} -``` -如此,普通用户可以执行`!plugin`查看插件列表,而仅管理员可以执行`!plugin get `命令安装插件。 -命令节点权限支持缺省,这意味的您未在`cmdpriv.json`中设置权限的节点将使用默认的权限级别(见上方)。 - -### 敏感词过滤 - -在`sensitive.json`中编辑敏感词,并在`config.py`中设置 - -```Python -# 敏感词过滤开关,以同样数量的*代替敏感词回复 -# 请在sensitive.json中添加敏感词 -sensitive_word_filter = True -```