Skip to content

Commit 5d24750

Browse files
committed
feat(docs): update documentation for agent tools and configurations
- Rename "模型工具" to "Agent 工具" across sidebar and introduction - Update tool names: "网络浏览" to "网页浏览", "网络请求" to "URL 请求", "指定 API 请求" to "OpenAPI 请求" - Remove "代码执行" tool documentation and replace with "TODO 工具" and "群管(禁言)工具" - Add new documentation files for `todo.md` and `group.md` tools - Improve descriptions and warnings in existing tool docs - Update chat mode name from "plugin" to "agent" - Clarify configuration steps and enhance user guidance - Add image assets for new tool configurations
1 parent 66563f2 commit 5d24750

File tree

16 files changed

+153
-57
lines changed

16 files changed

+153
-57
lines changed

docs/.vitepress/config.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
311311
],
312312
},
313313
{
314-
text: "模型工具",
314+
text: "Agent 工具",
315315
collapsed: true,
316316
items: [
317317
{
@@ -323,15 +323,15 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
323323
link: "/guide/model-plugin-system/web-search",
324324
},
325325
{
326-
text: "网络浏览",
326+
text: "网页浏览",
327327
link: "/guide/model-plugin-system/web-browser",
328328
},
329329
{
330-
text: "网络请求",
330+
text: "URL 请求",
331331
link: "/guide/model-plugin-system/request-web",
332332
},
333333
{
334-
text: "指定 API 请求",
334+
text: "OpenAPI 请求",
335335
link: "/guide/model-plugin-system/specify-api-request",
336336
},
337337
{
@@ -355,8 +355,12 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
355355
link: "/guide/model-plugin-system/thinking",
356356
},
357357
{
358-
text: "代码执行",
359-
link: "/guide/model-plugin-system/code-interpreter",
358+
text: "TODO 工具",
359+
link: "/guide/model-plugin-system/todo",
360+
},
361+
{
362+
text: "群管(禁言)工具",
363+
link: "/guide/model-plugin-system/group",
360364
},
361365
{
362366
text: "主动记忆",

docs/ecosystem/plugin/search-service.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@
1919

2020
但大部分搜索引擎都需要额外的配置相关参数,才能正常使用。
2121

22+
> [!TIP] 提示
23+
> 由于免费 API 的搜索精度问题,我们不推荐你使用下面这三个搜索引擎。
24+
>
25+
> 你可以选择 `tavily` 、 `serper` 等需要 API Key 的搜索引擎。
26+
2227
#### bing-web、google-web、duckduckgo-lite
2328

2429
只需确认 `puppeteer` 插件启用,并且你的网络环境可以正常访问 Bing、Google 和 DuckDuckGo 即可。

docs/guide/chat-chain/chat-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ChatLuna 中内置了以下几种聊天模式:
88

99
- **chat**: 默认,也是最基本的聊天模式,支持预设的全部功能(世界书,作者注释等),并且也支持长期记忆。
1010

11-
- **plugin**: 基于 LangChain 的 Agent 提供的聊天模式。可以让模型调用多样化的工具,大幅扩展模型的能力。
11+
- **agent**: 基于 LangChain 的 Agent 提供的聊天模式。可以让模型调用多样化的工具,大幅扩展模型的能力。
1212

1313
不仅如此,ChatLuna 团队还维护以下聊天模式:
1414

docs/guide/chat-chain/output-mode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 渲染输出
22

3-
ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模型输出渲染为不同的格式
3+
ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模型的输出渲染为不同的格式
44

55
目前 ChatLuna 内置了以下几种输出:
66

@@ -40,7 +40,7 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
4040

4141
## 语音输出
4242

43-
对于语音输出,你需要前往 Koishi 插件市场,安装并配置实现了 `vits` 服务的插件。
43+
要使用语音输出,你需要前往 Koishi 插件市场,安装并配置实现了 `vits` 服务的插件。
4444

4545
![alt text](../../public/images/image-34.png)
4646

docs/guide/model-plugin-system/active-memory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
相比被动的 [长期记忆](../session-related/long-term-memory.md),主动记忆工具更偏向于与人类交流般的主动记忆信息。
44

55
> [!WARNING] 警告
6-
> 在最新版本 (v1.1.0) 的 ChatLuna 中,主动记忆工具已经被整合到了 [长期记忆](../../ecosystem/plugin/long-term-memory.md)
7-
> 你只需要启用长期记忆插件即可。此教程仅作为旧版本的参考。
6+
> v1.1 以上版本的 ChatLuna 中,主动记忆工具已经被整合到了 [长期记忆](../../ecosystem/plugin/long-term-memory.md) 插件里
7+
> 你只需要启用长期记忆插件,即可自动注册相关工具。此教程仅作为旧版本的参考。
88

99
## 配置
1010

docs/guide/model-plugin-system/code-interpreter.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/guide/model-plugin-system/cron.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77
## 配置
88

99
- 参考 [介绍](introduction.md) 中的配置方法,启用 `plugin-common` 插件。
10-
- 前往插件市场搜索 `schedule` 插件并安装。
11-
- (可选) 前往插件市场搜索 `echo` 插件并安装。
1210
- 按照下图配置在 `plugin-common` 插件中启用 `cron` 选项。
1311

1412
![alt text](../../public/images/image-39.png)

docs/guide/model-plugin-system/file-io.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 文件读写
22

3-
此工具为模型提供了在本地文件系统中读写文件的能力
3+
此工具为模型提供了在本地文件系统中任意读写文件,搜索目录的能力
44

55
## 配置
66

@@ -11,7 +11,9 @@
1111

1212
## 测试
1313

14-
将当前房间设置为 Agent 模式,即可询问模型阅读文件,当文件阅读内容成功时,则说明工具启用成功。
14+
将当前房间设置为 Agent 模式,即可询问模型阅读,编写文件。
15+
16+
当文件阅读内容成功时,则说明工具启用成功。
1517

1618
::: warning 警告
1719
目前文件工具只能阅读纯文本内容,对于二进制文件暂时无法读取!
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 群管(禁言)工具
2+
3+
此工具可以让模型禁言群成员。(需要模型为管理员权限)
4+
5+
## 配置
6+
7+
- 前往 Koishi 插件市场,搜索 `chatluna-plugin-common`,并安装。
8+
9+
- 按照下图配置在 `plugin-common` 插件中启用 `group` 功能。
10+
11+
![alt text](../../public/images/image-88.png)
12+
13+
## 测试
14+
15+
尝试让模型禁言某个人,成功后则代表能正常启用。

docs/guide/model-plugin-system/introduction.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
1-
# 模型工具
1+
# Agent 工具
22

3-
模型工具是 ChatLuna 的核心功能之一,专为 Agent 模式设计。开发者可以创建并注册自定义工具到 ChatLuna 中,使模型能够在 Agent 模式下调用这些工具,从而扩展模型的能力
3+
Agent 工具是 ChatLuna 的核心功能之一,专为 Agent 模式设计。开发者可以创建并注册自定义工具到 ChatLuna 中,让模型能够在 Agent 模式下调用这些工具,大幅扩展模型的能力
44

55
## 配置
66

77
前往 Koishi 的插件市场,搜索 `chatluna-plugin-common`,并安装。
88

9-
此插件还需要配置后才能使用,你可以在下面的介绍中选择你喜欢的模型工具,按照其介绍进行配置。
9+
此插件需要进行一些配置后才能使用。
10+
11+
你可以在下面的介绍中选择你喜欢的模型工具,按照其介绍进行配置。
1012

1113
::: tip 提示
12-
建议在主插件中开启 [`showThoughtMessage`](../useful-configurations.md#showThoughtMessage) 选项。可以让模型在调用工具时,显示调用过程。
14+
建议在主插件中开启 [`showThoughtMessage`](../useful-configurations.md#showThoughtMessage) 选项。可以让 Agent在调用工具时,显示调用过程。
1315
:::
1416

1517
## 可用工具
1618

1719
目前 ChatLuna 支持以下的模型工具:
1820

1921
- [联网搜索](web-search.md)
20-
- [网络浏览](web-browser.md)
21-
- [网络请求](request-web.md)
22+
- [网页浏览](web-browser.md)
23+
- [OpenAPI 请求](request-web.md)
2224
- [文件读写](file-io.md)
2325
- [Koishi 命令执行](command-execution.md)
2426
- [定时任务](cron.md)
2527
- [文生图](draw.md)
2628
- [思考工具](thinking.md)
27-
- [代码执行](code-interpreter.md)
29+
- [TODO 工具](todo.md)
30+
- [群管工具](group.md)
2831
- [主动记忆](active-memory.md)
2932
- [简易音频生成](simple-audio-generation.md)
3033

0 commit comments

Comments
 (0)