|
21 | 21 | #### request |
22 | 22 |
|
23 | 23 | - 类型:`boolean` |
24 | | -- 默认值:`false` |
| 24 | +- 默认值:`true` |
25 | 25 |
|
26 | 26 | 是否启用网络请求工具。开启后,模型可以调用 `request_get` 和 `request_post` 工具进行网络的 GET 和 POST 请求。 |
27 | 27 |
|
| 28 | +另外可以参考 [request 插件配置](#request-插件配置) 配置请求工具的相关选项。 |
| 29 | + |
28 | 30 | #### fs |
29 | 31 |
|
30 | 32 | - 类型:`boolean` |
31 | 33 | - 默认值:`false` |
32 | 34 |
|
33 | 35 | 是否启用文件读写工具。开启后,模型可以调用 `file_write` 和 `file_read` 工具读写文件。 |
34 | 36 |
|
35 | | -另外可以参考 [fs 插件配置](#fs) 配置文件读写的作用域。 |
| 37 | +另外可以参考 [fs 插件配置](#fs-插件配置) 配置文件读写的作用域。 |
36 | 38 |
|
37 | 39 | #### group |
38 | 40 |
|
|
55 | 57 | #### chat |
56 | 58 |
|
57 | 59 | - 类型:`boolean` |
58 | | -- 默认值:`false` |
| 60 | +- 默认值:`true` |
59 | 61 |
|
60 | 62 | 是否启用聊天工具。开启后,模型可以调用 `chat` 工具。该工具会等待用户的输入,返回给模型。 |
61 | 63 |
|
|
66 | 68 |
|
67 | 69 | 是否启用思考工具。开启后,模型可以调用 `think` 工具。该工具会基于模型输入的内容,调用其他模型进行思维链推理,返回推理结果。一定程度上提升模型输出的质量。 |
68 | 70 |
|
| 71 | +#### todos |
| 72 | + |
| 73 | +- 类型:`boolean` |
| 74 | +- 默认值:`true` |
| 75 | + |
| 76 | +是否启用待办事项工具。开启后,模型可以调用 `todos` 工具。该工具可让 Agent 生成多步骤的待办事项,自动拆解任务。 |
| 77 | + |
69 | 78 | #### cron |
70 | 79 |
|
71 | 80 | - 类型:`boolean` |
72 | | -- 默认值:`false` |
| 81 | +- 默认值:`true` |
73 | 82 |
|
74 | 83 | 是否启用定时任务工具。开启后,模型可以调用 `cron` 工具。 |
75 | 84 |
|
| 85 | +另可参考 [定时任务插件配置](#定时任务插件配置) 配置定时任务工具。 |
| 86 | + |
76 | 87 | #### send |
77 | 88 |
|
78 | 89 | - 类型:`boolean` |
79 | | -- 默认值:`false` |
| 90 | +- 默认值:`true` |
80 | 91 |
|
81 | 92 | 是否启用发送消息工具。开启后,模型可以调用 `send` 工具。该工具会发送消息给用户。 |
82 | 93 |
|
|
87 | 98 |
|
88 | 99 | 是否启用文生图工具。开启后,模型可以调用 `draw` 工具。该工具会基于模型输入的内容,调用 Koishi 上的文生图插件,生成图片。 |
89 | 100 |
|
90 | | -另可参考 [文生图插件配置](#draw) 配置文生图工具。 |
| 101 | +另可参考 [画图插件配置](#画图插件配置) 配置文生图工具。 |
91 | 102 |
|
92 | | -#### codeSandbox |
| 103 | +#### music |
93 | 104 |
|
94 | 105 | - 类型:`boolean` |
95 | 106 | - 默认值:`false` |
96 | 107 |
|
97 | | -是否启用代码执行工具。开启后,模型可以调用 `codeSandbox` 工具。该工具会基于模型输入的内容,执行 Python 代码。 |
| 108 | +是否启用音乐播放工具。开启后,模型可以调用 `music` 工具,播放音乐。 |
98 | 109 |
|
99 | | -参考 [代码执行器配置](#代码执行器配置) 配置代码执行工具所需的 API 密钥。 |
| 110 | +在启用此工具前,需要确保 Koishi 的 `@dgck81lnn/music` 插件已启用。 |
| 111 | + |
| 112 | +另可参考 [音乐生成插件配置](#音乐生成插件配置) 配置音乐工具。 |
100 | 113 |
|
101 | | -#### memory |
| 114 | +#### actions |
102 | 115 |
|
103 | 116 | - 类型:`boolean` |
104 | 117 | - 默认值:`false` |
105 | 118 |
|
106 | | -是否启用主动记忆工具。开启后,模型可以调用 `memory_save` 和 `memory_search` 工具,保存和搜索用户的记忆。 |
| 119 | +是否启用 OpenAPI 工具调用功能。开启后,模型可以调用自定义的 OpenAPI 工具。 |
107 | 120 |
|
108 | | -使用前需要确保主插件的长期记忆功能是否能正常启用,正确配置了向量数据库和嵌入模型。 |
| 121 | +另可参考 [OpenAPI 工具调用插件配置](#openapi-工具调用插件配置) 配置 OpenAPI 工具。需要启用 request 工具才能请求。 |
109 | 122 |
|
110 | | -#### knowledge |
| 123 | +### request 工具配置 |
111 | 124 |
|
112 | | -- 类型:`boolean` |
113 | | -- 默认值:`false` |
| 125 | +#### requestMaxOutputLength |
114 | 126 |
|
115 | | -是否启用知识库工具。开启后,模型可以调用 `knowledge` 工具,搜索知识库中的内容。 |
| 127 | +- 类型:`number` |
| 128 | +- 默认值:`58600` |
116 | 129 |
|
117 | | -另可参考 [知识库插件配置](#knowledge) 配置知识库工具。 |
| 130 | +request 插件最大输出长度。 |
118 | 131 |
|
119 | | -#### music |
| 132 | +#### requestSelector |
120 | 133 |
|
121 | | -- 类型:`boolean` |
122 | | -- 默认值:`false` |
| 134 | +- 类型:`string[]` |
| 135 | +- 默认值:`['请求', 'request', 'get', 'post', '获取', '调用', 'api', 'http']` |
123 | 136 |
|
124 | | -是否启用音乐播放工具。开启后,模型可以调用 `music` 工具,播放音乐。 |
| 137 | +触发 request 工具的关键词。为空时始终选中。 |
125 | 138 |
|
126 | | -在启用此工具前,需要确保 Koishi 的 `@dgck81lnn/music` 插件已启用。 |
| 139 | +#### requestHeaders |
| 140 | + |
| 141 | +- 类型:`{ matcher: string, headers: Record<string, string> }[]` |
| 142 | +- 默认值:`[]` |
| 143 | + |
| 144 | +根据域名匹配设置请求头。 |
| 145 | + |
| 146 | +##### requestHeaders.matcher |
| 147 | + |
| 148 | +- 类型:`string` |
| 149 | +- 默认值:`` |
| 150 | + |
| 151 | +域名匹配模式(支持通配符,如 `*.example.com`, `api.github.com`)。 |
| 152 | + |
| 153 | +##### requestHeaders.headers |
| 154 | + |
| 155 | +- 类型:`Record<string, string>` |
| 156 | +- 默认值:`{}` |
| 157 | + |
| 158 | +该域名匹配时应用的请求头。 |
127 | 159 |
|
128 | 160 | ### fs 插件配置 |
129 | 161 |
|
|
132 | 164 | - 类型:`string` |
133 | 165 | - 默认值:`` |
134 | 166 |
|
135 | | -文件读写的作用域。留空则为任意路径。 |
| 167 | +文件读写的作用域。留空则为系统任意路径。 |
| 168 | + |
| 169 | +#### fsSelector |
| 170 | + |
| 171 | +- 类型:`string[]` |
| 172 | +- 默认值:`['文件', 'file', '读取', '写入', '查找', '搜索', 'read', 'write', 'search', '路径', 'path']` |
| 173 | + |
| 174 | +触发 fs 工具的关键词。为空时始终选中。 |
| 175 | + |
| 176 | +#### fsIgnores |
| 177 | + |
| 178 | +- 类型:`string[]` |
| 179 | +- 默认值:`['**/node_modules/**', '**/.git/**', '**/dist/**', '**/build/**', '**/.yarn/**', '**/coverage/**', '**/.next/**', '**/.nuxt/**', '**/out/**', '**/.cache/**', '**/.vscode/**', '**/.idea/**', '**/temp/**', '**/tmp/**']` |
| 180 | + |
| 181 | +默认忽略的文件夹表达式。 |
| 182 | + |
| 183 | +### 指令工具配置 |
| 184 | + |
| 185 | +#### commandWithSend |
| 186 | + |
| 187 | +- 类型:`boolean` |
| 188 | +- 默认值:`true` |
136 | 189 |
|
137 | | -### 指令插件配置 |
| 190 | +是否默认发送指令的执行结果。 |
138 | 191 |
|
139 | 192 | #### commandList |
140 | 193 |
|
141 | | -- 类型:`{ command: string, description: string, selector: string[] }[]` |
| 194 | +- 类型:`{ command: string, description: string, selector: string[], confirm: boolean }[]` |
142 | 195 | - 默认值:`[]` |
143 | 196 |
|
144 | | -需要注册的指令列表。 |
| 197 | +需要注册的指令列表。不填写则默认注册所有一级指令。 |
145 | 198 |
|
146 | 199 | ##### commandList.command |
147 | 200 |
|
|
164 | 217 |
|
165 | 218 | 指令的触发条件。当聊天内容包含这些关键词时,此指令才会注册给模型。 |
166 | 219 |
|
167 | | -### 代码执行器配置 |
| 220 | +##### commandList.confirm |
168 | 221 |
|
169 | | -#### codeSandboxAPIKey |
170 | | - |
171 | | -- 类型:`string` |
172 | | -- 默认值:`` |
| 222 | +- 类型:`boolean` |
| 223 | +- 默认值:`true` |
173 | 224 |
|
174 | | -代码执行工具所需的 API 密钥。密钥需要前往 [e2b](https://e2b.dev/) 获取。 |
| 225 | +执行指令时是否需要二次确认。 |
175 | 226 |
|
176 | 227 | ### 群管插件配置 |
177 | 228 |
|
|
180 | 231 | - 类型:`string[]` |
181 | 232 | - 默认值:`[]` |
182 | 233 |
|
183 | | -群管理员账号列表。 |
| 234 | +允许使用群管功能的成员 ID 列表。 |
| 235 | + |
| 236 | +#### groupWhitelist |
| 237 | + |
| 238 | +- 类型:`string[]` |
| 239 | +- 默认值:`[]` |
| 240 | + |
| 241 | +允许使用群管功能的群 ID 白名单。为空时在所有群可用。 |
184 | 242 |
|
185 | | -### 画图插件配置 |
| 243 | +### 定时工具配置 |
| 244 | + |
| 245 | +#### cronScopeSelector |
| 246 | + |
| 247 | +- 类型:`string[]` |
| 248 | +- 默认值:`[]` |
| 249 | + |
| 250 | +允许使用命令类型定时任务的成员 ID 列表。为空时所有人都可以创建提醒任务,但无法创建命令任务。 |
| 251 | + |
| 252 | +### 画图工具配置 |
186 | 253 |
|
187 | 254 | #### drawPrompt |
188 | 255 |
|
|
196 | 263 | - 类型:`string` |
197 | 264 | - 默认值:`nai {prompt}` |
198 | 265 |
|
199 | | -画图时实际执行的指令。 |
| 266 | +画图时实际执行的指令。`{prompt}` 为调用时的 prompt。 |
| 267 | + |
| 268 | +#### drawSelector |
| 269 | + |
| 270 | +- 类型:`string[]` |
| 271 | +- 默认值:`['画', 'image', 'sd', '图', '绘', 'draw', '生成', 'generate', '创作', 'create']` |
| 272 | + |
| 273 | +触发绘画工具的关键词。为空时始终选中。 |
| 274 | + |
| 275 | +### 音乐工具配置 |
| 276 | + |
| 277 | +#### musicSelector |
| 278 | + |
| 279 | +- 类型:`string[]` |
| 280 | +- 默认值:`['音乐', 'music', '歌曲', 'song', '音频', 'audio', '创作', 'create', '生成', 'generate']` |
| 281 | + |
| 282 | +触发音乐生成工具的关键词。为空时始终选中。 |
| 283 | + |
| 284 | +### OpenAPI 工具调用插件配置 |
| 285 | + |
| 286 | +#### actionsList |
| 287 | + |
| 288 | +- 类型:`{ name: string, description: string, openAPISpec: string, headers: Record<string, string>, selector: string[] }[]` |
| 289 | +- 默认值:`[]` |
| 290 | + |
| 291 | +可用 OpenAPI 工具列表。 |
| 292 | + |
| 293 | +##### actionsList.name |
| 294 | + |
| 295 | +- 类型:`string` |
| 296 | +- 默认值:`` |
| 297 | + |
| 298 | +工具名称。请使用纯英文的名称。 |
| 299 | + |
| 300 | +##### actionsList.description |
| 301 | + |
| 302 | +- 类型:`string` |
| 303 | +- 默认值:`` |
| 304 | + |
| 305 | +工具描述。 |
| 306 | + |
| 307 | +##### actionsList.openAPISpec |
| 308 | + |
| 309 | +- 类型:`string` |
| 310 | +- 默认值:`` |
| 311 | + |
| 312 | +OpenAPI 规范文件内容。 |
| 313 | + |
| 314 | +##### actionsList.headers |
200 | 315 |
|
201 | | -### 知识库插件配置 |
| 316 | +- 类型:`Record<string, string>` |
| 317 | +- 默认值:`{}` |
202 | 318 |
|
203 | | -> [!WARNING] 警告 |
204 | | -> 启用此工具前需要配置知识库插件,前往 [知识库插件文档](../extension/knowledge.md) 查看用法。 |
| 319 | +工具请求头。 |
205 | 320 |
|
206 | | -#### knowledgeId |
| 321 | +##### actionsList.selector |
207 | 322 |
|
208 | 323 | - 类型:`string[]` |
209 | 324 | - 默认值:`[]` |
210 | 325 |
|
211 | | -知识库的 ID 列表。 |
| 326 | +触发工具的关键词。 |
0 commit comments