Skip to content

Commit 701b8c9

Browse files
committed
docs: update model platform configuration and command documentation
- Fix punctuation and grammar in introduction.md - Improve OpenAI adapter usage instructions and add example test output - Add new section for testing model availability in useful-commands/model.md - Update bot configuration options including botNames, nickname matching, and message queue settings in useful-configurations.md - Clarify chat mode descriptions and remove deprecated historyMode config - Revise frontpage feature description for agentic capabilities
1 parent 595cb2c commit 701b8c9

File tree

5 files changed

+93
-44
lines changed

5 files changed

+93
-44
lines changed

docs/guide/configure-model-platform/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ChatLuna 的模型平台是其核心功能之一。它为 ChatLuna 核心和各
2222
- [RWKV](rwkv.md)
2323
- [混元大模型](hunyuan.md)
2424

25-
对于 OpenAI 兼容 API(如 [One API](https://github.com/songquanpeng/one-api)[New API](https://github.com/QuantumNous/new-api),可以使用以下适配器进行多开接入:
25+
对于 OpenAI 兼容 API(如 [One API](https://github.com/songquanpeng/one-api)[New API](https://github.com/QuantumNous/new-api),可以使用以下适配器进行多开接入:
2626

2727
- [OpenAI Like](openai-like.md)
2828

docs/guide/configure-model-platform/openai.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,25 @@ OpenAI 模型适配器还支持多模态和 Agent 模式。允许模型读取图
3434

3535
## 使用
3636

37-
在 OpenAI 适配器的配置页面,点击运行按钮,如无误,你应该看不到任何错误 log,那即可转到 ChatLuna 的主插件页面
37+
在 OpenAI 适配器的配置页面,点击运行按钮,检查你的日志界面,是否有看到错误日志
3838

39-
在主插件页面,下划到 [模版房间选项](../useful-configurations.md#模版房间选项),查看 [defaultModel](../useful-configurations.md#defaultmodel) 的选项里是否含有 OpenAI 模型,如果有,则说明你已经成功地接入了 OpenAI 平台。
39+
如无误,则可以转到沙盒或者其他聊天平台,使用 `chatluna.model.test` 命令查看是否接入成功:
4040

41-
![images](../../public/images/plugin_main_pic_1.png)
41+
<chat-panel>
42+
<chat-message nickname="User">chatluna.model.test openai/gpt-4.1-nano</chat-message>
43+
<chat-message nickname="Bot">模型 openai-like/gpt-4.1-nano 测试成功!<br/>
44+
响应时间:2255ms<br/>
45+
示例回复:Hello! How can I assist you today?<br/>
46+
</chat-message>
47+
</chat-panel>
48+
49+
测试成功后,则代表你已成功接入 OpenAI 平台,可以正常使用了。
4250

4351
## 常见问题
4452

4553
### 1. 国内平台如何接入?
4654

47-
国内平台接入 OpenAI 官方的接口,需要代理设置前往主插件的配置页面,开启 [代理模式](../useful-configurations.md/#isproxy),并配置 [代理地址](../useful-configurations.md#proxyaddress)
55+
国内平台接入 OpenAI 官方的接口,需要代理设置前往主插件的配置页面,开启 [代理模式](../useful-configurations.md/#isproxy),并配置 [代理地址](../useful-configurations.md#proxyaddress)
4856

4957
> [!TIP] 提示
5058
> 社区成员提供了免费的反向代理地址,使用反向代理地址无需开启代理模式,请在确认风险后使用。

docs/guide/useful-commands/model.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ ChatLuna 提供了一些使用的模型指令,用于查看和设置模型。
99
>
1010
> 阅读 [模型平台](../configure-model-platform/introduction.md) 了解更多。
1111
12+
## 测试模型可用性
13+
14+
测试当前平台或模型的可用性。
15+
16+
以下为命令格式:
17+
18+
```powershell
19+
chatluna.model.test <model:string>
20+
```
21+
22+
以下为必须参数:
23+
24+
- `model:string`: 模型名称。也可以是一个平台名称,如:(`openai`,`openai/gpt-4.1-nano`
25+
26+
以下为例子:
27+
<chat-panel>
28+
<chat-message nickname="User">chatluna.model.test openai/gpt-4.1-nano</chat-message>
29+
<chat-message nickname="Bot">模型 openai-like/gpt-4.1-nano 测试成功!<br/>
30+
响应时间:2255ms<br/>
31+
示例回复:Hello! How can I assist you today?<br/>
32+
</chat-message>
33+
</chat-panel>
34+
1235
## 列出大语言模型列表
1336

1437
列出当前 ChatLuna 可用的大语言模型列表。

docs/guide/useful-configurations.md

Lines changed: 55 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,30 @@
44

55
## Bot 配置
66

7-
### botName
7+
### botNames
88

9-
- 类型:`string`
10-
- 默认值:`香草`
9+
- 类型:`string[]`
10+
- 默认值:`[香草]`
1111

1212
Bot 的昵称,该昵称可用于下方的 [关键词唤醒](#isnickname) 对话。
1313

14+
如果设置了多个昵称,只有第一个昵称会作为 bot 的名称。其他关键词仅用于触发会话。
15+
1416
### isNickName
1517

1618
- 类型:`boolean`
1719
- 默认值:`false`
1820

19-
是否可从昵称唤醒对话。当开启后,如发出的消息开头含有 [botName](#botname) 属性,将自动触发对话。
21+
是否可从昵称唤醒对话。当开启后,如发出的消息开头含有 [botNames](#botnames) 属性,将自动触发对话。
22+
23+
### isNickNameWithContent
24+
25+
- 类型:`boolean`
26+
- 默认值:`false`
27+
28+
是否允许在对话内容里任意匹配 bot 配置中的昵称来触发对话。
29+
30+
开启后,当消息内容里包含 bot 昵称,将自动触发对话。
2031

2132
## 对话行为选项
2233

@@ -46,11 +57,14 @@ Bot 回复时是否引用原消息回复。开启后 Bot 的回复都会引用
4657
- 类型: `boolean`
4758
- 默认值:`false`
4859

49-
是否让消息以转发消息的形式发送。开启后,当 Bot 回复时,将会回复一个转发消息组。
60+
是否让消息以合并消息的形式发送。开启后,当 Bot 回复时,将会回复一个转发消息组。
5061

51-
:::warning 警告
52-
目前支持该功能的聊天平台可能很少或接近没有,在未来我们可能会删除该配置项。
53-
:::
62+
### forwardMsgMinLength
63+
64+
- 类型:`number`
65+
- 默认值:`0`
66+
67+
当开启 [isForwardMsg](#isforwardmsg) 选项时,当消息长度超过该值时,将消息以合并消息的形式发送。为 0 表示总是合并消息。
5468

5569
### privateChatWithoutCommand
5670

@@ -68,6 +82,14 @@ Bot 回复时是否引用原消息回复。开启后 Bot 的回复都会引用
6882

6983
是否允许使用房间名前缀触发对话。注意:启用此选项可能会显著影响 ChatLuna 的性能,建议配合过滤器仅在特定群组中启用。
7084

85+
### includeQuoteReply
86+
87+
- 类型:`boolean`
88+
- 默认值:`false`
89+
90+
是否在回复内容中包含引用消息的内容。开启后,将会引用触发模型生成的消息。
91+
92+
7193
### randomReplyFrequency
7294

7395
- 类型:`number`
@@ -105,7 +127,24 @@ Bot 回复时是否引用原消息回复。开启后 Bot 的回复都会引用
105127
- 最大值:`3600`
106128
- 单位:`秒(s)`
107129

108-
全局冷却时间,开启后,在该时间内,Bot 不会响应任何消息。
130+
全局冷却时间。
131+
开启后,当响应一跳消息后,在此时间内,Bot 不会再响应任何消息。
132+
133+
### messageQueue
134+
135+
- 类型:`boolean`
136+
- 默认值:`true`
137+
138+
是否启用消息队列。
139+
当发送了多条消息,并且模型未响应消息时,会将多条消息合并成一条消息,等待模型响应后再次发送。
140+
141+
### messageQueueDelay
142+
143+
- 类型:`number`
144+
- 默认值:`0`
145+
146+
消息队列的延迟时间,为 0 则不启用延迟。
147+
开启延迟后,等待指定时间后才发送消息给模型。此期间存在未处理的消息时,会将消息缓存合并成一条消息,发送给模型。
109148

110149
### showThoughtMessage
111150

@@ -146,7 +185,7 @@ Bot 回复时是否引用原消息回复。开启后 Bot 的回复都会引用
146185
- 默认值:`'text'`
147186

148187
::: warning 警告
149-
如你开启了 [流式传输](#streamresponse)那么输出格式请直接选择默认的 `text`
188+
如你开启了 [流式传输](#streamresponse)那么输出格式请选择默认的 `text`
150189
否则可能出现意想不到的渲染结果。
151190
:::
152191

@@ -203,19 +242,6 @@ Bot 回复时是否引用原消息回复。开启后 Bot 的回复都会引用
203242

204243
数据库里存储的单个对话的最大消息数量,超出后会自动删除最久远的历史聊天消息。
205244

206-
### historyMode
207-
208-
- 类型: `default` | `summary`
209-
- 默认值: `default`
210-
211-
历史聊天的模式,可选:
212-
213-
- default: 默认模式,将历史消息原封不动的发送给模型。
214-
- summary: 摘要模式,只发送一条历史消息,其内容为模型总结的历史消息的摘要。
215-
216-
使用 `summary` 模式时更能节省 token,但是也可能会遇到未知的 bug,连续对话效果不好。
217-
使用 `default` 模式时对话效果更佳,兼容性也最好。
218-
219245
### autoDelete
220246

221247
- 类型: `boolean`
@@ -263,12 +289,13 @@ ChatLuna 默认使用的向量数据库。
263289

264290
模版克隆房间里默认使用的聊天模式。
265291

266-
由于 ChatLuna 扩展开放了该接口,因此任何插件都可以编写自己的聊天模式相关链接入到 ChatLuna 中。
267-
下面只介绍 ChatLuna 内置的几个聊天模式:
292+
ChatLuna 扩展开放了聊天链接口,任何插件都可以编写自己的聊天模式相关链接入到 ChatLuna 中。
293+
294+
下面介绍 ChatLuna 内置的几个聊天模式:
268295

269-
- chat: 普通聊天模式,支持预设和长期记忆,没有联网权限。
270-
- browsing: 浏览模式,支持预设和长期记忆,可以通过与用户的聊天内容从网络上搜索信息。
271-
- plugin: Agent 模式,不完全支持预设,不支持长期记忆,模型可以调用各种工具如网络搜索插件,可以自主获取网络上的消息和执行某些操作
296+
- chat: 普通聊天模式,不支持工具调用,支持大部分扩展插件,没有联网权限。
297+
- browsing: 浏览模式,不支持工具调用,可以通过与用户的聊天内容从网络上搜索信息。
298+
- plugin: Agent 模式,支持工具调用,模型可以调用各种工具如网络搜索插件,可以自主获取网络上的消息,执行某些操作
272299

273300
### defaultModel
274301

@@ -295,15 +322,6 @@ ChatLuna 默认使用的向量数据库。
295322

296323
## 杂项
297324

298-
### authSystem <Badge type="warning" text="实验性" />
299-
300-
- 类型: `boolean`
301-
- 默认值: `false`
302-
303-
配额组和其相关的用户系统。
304-
305-
如需了解,可查看 [配额组和用户系统](../guide/session-related/concurrency-limit.md)
306-
307325
### isProxy
308326

309327
- 类型: `boolean`

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ features:
2424
title: 多模型集成
2525
details: 集成 Deepseek、OpenAI、Google Gemini、Anthropic Claude 等主流平台,并持续扩展更多平台。
2626
- icon: 🔗
27-
title: Agent 工具调用
28-
details: Agent 模式,可以让模型任意调用已有工具。支持联网搜索,知识库等复杂工具。
27+
title: Agentic 能力
28+
details: 使用 Agent 模式,可以让模型任意调用已有工具。支持 MCP,联网搜索,知识库等复杂工具。
2929
- icon: 🎨
3030
title: 多模态与渲染输出
3131
details: 支持图片多模态,并可渲染模型回复,支持文本、图片、语音等多种格式。

0 commit comments

Comments
 (0)