diff --git a/docs/guide/useful-commands.md b/docs/guide/useful-commands.md index e8ccf1bc..0f2973c1 100644 --- a/docs/guide/useful-commands.md +++ b/docs/guide/useful-commands.md @@ -80,6 +80,127 @@ chatluna.room.switch +### 创建房间 + +创建新的房间，并将当前环境的默认房间切换为新创建的房间。 + +此命令是目前已知的 ChatLuna 里前三复杂的指令。 + +命令含有两种模式，如果没有携带任何子参数，则自动进入交互式创建，否则将直接基于子参数进行创建。 + +以下为命令格式： + +```shell +chatluna.room.create -n -p -m -c -w -v +``` + +以下为可选参数： + +- `-n,--name`: 指定房间的名字。 +- `-p,--preset`: 指定房间的预设。 +- `-m,--model`: 指定房间的模型。 +- `-c,--chatMode`: 指定房间的聊天模式。 +- `-w,--password`: 指定房间的密码。 + +在这里我们只介绍交互式创建的例子，如需自己使用子参数，请自行摸索（或等待文档继续完善）。 + + + chatluna.room.create + + 请输入你需要使用的房间名，如：我的房间 + + 测试 + + 请输入你需要使用的模型，如：openai/gpt-3.5-turbo + + openai/gpt-3.5-turbo + + 请输入你需要使用的聊天模式，如：chat + + chat + + 请输入你需要使用的预设，如：chatgpt。如果不输入预设请回复 N（则使用默认 chatgpt 预设）。否则回复你需要使用的预设。 + + chatgpt + + 请输入你需要使用的可见性，如：private。如果不输入可见性请回复 N（则使用默认 private 可见性）。否则回复你需要使用的可见性。(目前支持 public, private) + + 房间创建成功，房间号为：2，房间名为：测试。 + + +### 设置房间 + +设置当前环境的默认房间的配置。 + +此命令是目前已知的 ChatLuna 里前三复杂的指令。 + +和创建房间一样，命令含有两种模式，如果没有携带任何子参数，则自动进入交互式创建，否则将直接基于子参数进行创建。 + +以下为命令格式： + +```shell +chatluna.room.set -n -p -m -c -w -v +``` + +以下为可选参数： + +- `-n,--name`: 指定房间的名字。 +- `-p,--preset`: 指定房间的预设。 +- `-m,--model`: 指定房间的模型。 +- `-c,--chatMode`: 指定房间的聊天模式。 +- `-w,--password`: 指定房间的密码。 +- `-v,--visibility`: 指定房间的可见性。 + +如果你想更换当前环境默认房间的模型，可以只带上 `-m` 参数，如： + + + chatluna.room.set -m openai/gpt-3.5-turbo + + 你目前已设置参数，是否直接更新房间属性？如需直接更新请回复 Y，如需进入交互式创建请回复 N，其他回复将视为取消。 + + Y + + 房间 测试 已更新。 + + + +对于该命令，我们不推荐你使用交互式创建。 + +另外，如果你对该房间设置了新的预设，那么该房间之前的聊天记录会自动清空。 + +### 删除房间 + +删除某个已经加入了的房间。 + +:::warning 警告 +此命令只有房主能够执行。但如果执行者含有 3 级权限，那么也将会执行删除房间的操作。 +::: + +以下为命令格式： + +```shell +chatluna.room.delete +``` + +以下为可选参数： + +- `room`: 指定要删除的房间，默认为当前环境的默认房间。 + +以下为例子： + + + chatluna.room.delete 测试 + + 你确定要删除房间 测试 吗？这将会删除房间内的所有消息。并且成员也会被移除。如果你确定要删除，请输入 Y 来确认。 +
+ 输入 Y 确认删除房间。 + + Y + + 已删除房间 测试。 + + + ### 列出房间信息 列出在当前环境的默认使用的房间的信息 @@ -107,7 +228,7 @@ chatluna.room.info [room:text] 房间模型: bing/creative
房间可见性: template_clone
房间聊天模式: chat
-房间创建者ID: 2187778735
+房间创建者ID: 0
房间可用性：false
@@ -165,11 +286,11 @@ chatluna.room.transfer /chatluna.room.transfer @dingyi - 你确定要把房间 测试 转移给用户 2187778735 吗？转移后ta将成为房间的房主，你将失去房主权限。如果你确定要转移，请输入 Y 来确认。 + 你确定要把房间 测试 转移给用户 0 吗？转移后ta将成为房间的房主，你将失去房主权限。如果你确定要转移，请输入 Y 来确认。 Y - 已将房间 测试 转移给用户 2187778735。 + 已将房间 测试 转移给用户 0。 @@ -198,7 +319,7 @@ chatluna.room.invite <...arg:user> /chatluna.room.invite @dingyi - 已邀请用户 2187778735 加入房间 测试 + 已邀请用户 0 加入房间 测试 @@ -244,9 +365,9 @@ chatluna.room.kick <...arg:user> 以下为例子： - /chatluna.room.kick @dingyi + chatluna.room.kick @dingyi - 已将以下用户踢出房间 测试：2187778735 + 已将以下用户踢出房间 测试：0 @@ -271,11 +392,11 @@ chatluna.room.permission chatluna.room.permission @dingyi - 你确定要为用户 2187778735 设置房间 test 的权限吗？目前可以设置的权限为 member 和 admin。如果你确定要设置，请输入设置权限的值或首字母大写，其他输入均视为取消。 + 你确定要为用户 0 设置房间 test 的权限吗？目前可以设置的权限为 member 和 admin。如果你确定要设置，请输入设置权限的值或首字母大写，其他输入均视为取消。 admin - 已为用户 2187778735 设置房间 test 的权限为 admin + 已为用户 0 设置房间 test 的权限为 admin @@ -334,7 +455,7 @@ chatluna.room.list -l -p 房间模型: bing/creative
房间可见性: template_clone
房间聊天模式: chat
-房间创建者ID: 2187778735
+房间创建者ID: 0
房间可用性：false

房间名: 测试
@@ -343,7 +464,7 @@ chatluna.room.list -l -p 房间模型: openai/gpt-3.5-turbo
房间可见性: public
房间聊天模式: chat
-房间创建者ID: 2187778735
+房间创建者ID: 0
房间可用性：true

你可以使用 chatluna.room.switch <name/id> 来切换当前环境里你的默认房间。
@@ -456,7 +577,7 @@ chatluna.preset.add :::warning 警告 此命令需要被执行者含有 3 级权限。 -在未来我们可能会跟随 Koishi 更新，使用其他方式进行权限验证（权限组）。 + ::: 以下为命令格式： @@ -488,7 +609,6 @@ chatluna.preset.clone [newPresetName:string] :::warning 警告 此命令需要被执行者含有 3 级权限。 -在未来我们可能会跟随 Koishi 更新，使用其他方式进行权限验证（权限组）。 ::: 以下为命令格式： @@ -518,7 +638,6 @@ chatluna.preset.set :::warning 警告 此命令需要被执行者含有 3 级权限。 -在未来我们可能会跟随 Koishi 更新，使用其他方式进行权限验证（权限组）。 ::: 以下为命令格式： @@ -651,7 +770,6 @@ pinecone
:::warning 警告 此命令需要被执行者含有 3 级权限。 -在未来我们可能会跟随 Koishi 更新，使用其他方式进行权限验证（权限组）。 ::: :::tip 提示 @@ -667,7 +785,7 @@ chatluna.embeddings.set 以下为例子： - /chatluna.embeddings.set openai/text-embedding-ada-002 + chatluna.embeddings.set openai/text-embedding-ada-002 已将默认嵌入模型设置为 openai/openai/text-embedding-ada-002 (将自动重启插件应用更改) @@ -680,7 +798,6 @@ chatluna.embeddings.set :::warning 警告 此命令需要被执行者含有 3 级权限。 -在未来我们可能会跟随 Koishi 更新，使用其他方式进行权限验证（权限组）。 ::: :::tip 提示 @@ -700,3 +817,196 @@ chatluna.vectorstore.set 已将默认向量数据库设置为 faiss， (将自动重启插件应用更改) + +## 配额组和余额系统 + +目前此功能为实验性功能，随时可能会出现破坏性更改或移除。 + +如需使用相关功能，请先前往插件配置里开启[`authSystem`](./useful-configurations.md#authsystem)。 + +### 查询余额 + +查询某个用户的余额。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```shell +chatluna.balance.query [user:user] +``` + +以下为参数说明： + +- `user`: 指定查询的用户，如为空则默认为当前用户。 + +以下为例子： + + + chatluna.balance.query + 用户 0 当前的账户余额为 1 + + +### 清空余额 + +清空某个用户的余额。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```shell +chatluna.balance.clear [user:user] +``` + +以下为参数说明： + +- `user`: 指定清空的用户，如为空则默认为当前用户。 + +以下为例子： + + + chatluna.balance.clear + 已将用户 0 账户余额修改为 0 + + +### 设置余额 + +设置某个用户的余额。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```shell +chatluna.balance.set -u [user:user] [balance:number] +``` + +以下为参数说明： + +- `-u,--user`: 指定设置的用户，如为空则默认为当前用户。 +- `balance`: 指定设置的余额。 + +以下为例子： + + + chatluna.balance.set -u 0 100 + 已将用户 0 账户余额修改为 100 + + +### 添加用户到配额组 + +将某位用户添加到某个配额组。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```shell +chatluna.auth.add -u +``` + +以下为参数说明： + +- `-u,--user`: 指定添加的用户。 +- `group`: 指定添加的用户组。 + +以下为例子： + + + chathub.auth.add guest -u @dingyi + 已将用户 0 添加到配额组 guest + + +### 从配额组里移除用户 + +将某位用户从某个配额组中移除。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```sh +chathub.auth.kick -u +``` + +以下为参数说明： + +- `-u,--user`: 指定移除的用户。 +- `group`: 指定移除的用户组。 + +:::tip 提示 +此命令只会将用户从指定的配额组中移除，不会删除用户。 +::: + +以下为例子： + + + chathub.auth.kick guest -u @dingyi + 已将用户 2371124484 踢出配额组 admin + + +### 列出配额组 + +列出当前 ChatLuna 可用的配额组列表。 + +:::warning 警告 +此命令需要被执行者含有 3 级权限。 +::: + +以下为命令格式： + +```shell +chatluna.auth.list -l -p +``` + +以下为可选参数： + +- `-l,--limit`: 指定返回配额组名称的数量上限，默认为 3。 +- `-p,--page`: 指定返回配额组名称的页数，默认为 1。 + +以下为例子： + + + chatluna.auth.list -l 10 + 以下是查询到目前可用的配额组列表：
+ +
名称：admin
+适用模型平台：通用
+计费：1 / 1000 token
+优先级: 0
+限制模型：通用
+并发限制每 4 条消息/分
+并发限制每 4 条消息/天
+ +
名称：guest
+适用模型平台：通用
+计费：0.3 / 1000 token
+优先级: 0
+限制模型：通用
+并发限制每 10 条消息/分
+并发限制每 2000 条消息/天
+ +
名称：测试
+适用模型平台：通用
+计费：0.01 / 1000 token
+优先级: 1
+限制模型：openai/gpt-3.5-turbo-16k, openai/gpt-3.5-turbo-16k-0613
+并发限制每 10 条消息/分
+并发限制每 100 条消息/天
+ +
你可以使用 chathub.auth.add <name/id> 来加入某个配额组。
+ +
当前为第 1 / 1 页
+ + diff --git a/docs/guide/useful-configurations.md b/docs/guide/useful-configurations.md index b89628ca..0ab6a3f9 100644 --- a/docs/guide/useful-configurations.md +++ b/docs/guide/useful-configurations.md @@ -272,7 +272,7 @@ ChatLuna 默认使用的向量数据库。 ## 杂项 -### authSystem +### authSystem - 类型: `boolean` - 默认值: `false`