Skip to content

Commit 3ca24ba

Browse files
committed
feat(docs): update documentation for chat modes and model adapters
- Add 'Deepseek' to VS Code spell check words - Update sponsor list in docs with new entry for 'hoshino' - Improve clarity in chat mode descriptions - Refine output mode documentation, add 'pure-text' description - Clarify usage of AT messages in output mode settings - Revise stream output documentation formatting - Adjust text censor service description - Simplify embedding model introduction - Update model adapter instructions for Claude, DeepSeek, Gemini, Moonshot, OpenAI-Like, Qwen and RWKV platforms - Standardize model testing procedures across platform guides - Minor grammatical and stylistic improvements throughout docs
1 parent 701b8c9 commit 3ca24ba

17 files changed

Lines changed: 102 additions & 65 deletions

File tree

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"cSpell.words": [
33
"chatluna",
4+
"Deepseek",
45
"Dify",
56
"Koishi",
67
"newbing",

docs/about/sponsor.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@ const thinks = [
8383
name: "Cloudwind.♨",
8484
url: "#Cloudwind.♨",
8585
},
86+
{
87+
img: "https://pic1.afdiancdn.com/user/c60f4b68d62e11ed9a6052540025c377/avatar/6051a2e73dfd3a6fb35d3ae5307614d4_w1254_h1771_s288.png?imageView2/1/w/120/h/120",
88+
name: "hoshino",
89+
url: "#hoshino",
90+
},
8691
{
8792
img: "https://pic1.afdiancdn.com/user/user_upload_osl/bbcee7deba46b2c757460d6d2c35f0c3_w132_h132_s4.jpeg?imageView2/1/w/120/h/120",
8893
name:"MashiroSaber",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ agent 模式让模型可以调用工具,并根据工具的返回结果,继
3131
> [!TIP]
3232
> ChatLuna 主插件中没有内置可供 agent 聊天模式使用的工具。
3333
>
34-
> 因此你需要安装 [`chatluna-plugin-common`](../../ecosystem/introduction.md)[`chatluna-mcp-client`](../../ecosystem/plugin/mcp-client.md) 插件来为 agent 模式提供可用的工具。
34+
> 你需要安装 [`chatluna-plugin-common`](../../ecosystem/introduction.md)[`chatluna-mcp-client`](../../ecosystem/plugin/mcp-client.md) 插件来为 agent 模式提供可用的工具。
3535
3636
### browsing
3737

docs/guide/chat-chain/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
ChatLuna 自实现了一套中间件系统,将整个 ChatLuna 的命令和聊天处理流程串联起来。
44

5-
因此 ChatLuna 和其他第三方开发者可以基于这套中间件系统,自定义聊天链的某些流程
5+
因此 ChatLuna 和其他第三方开发者可以基于这套中间件系统,自定义聊天链的各种流程
66

77
这其中包含了诸如聊天模式,输出模式,文本审核,等功能。
88

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
66

77
- **raw**: 纯文本输出。将模型的回复内容直接输出。
88
- **text**: 基于 [koishi-plugin-markdown](https://markdown.koishi.chat/),将模型的(Markdown)回复内容渲染为 Koishi 消息格式,输出到聊天平台上。
9+
- **pure-text**: 纯文本输出。与 `raw` 不同的是,此模式会移除所有的 Markdown 标记。返回纯净文本。
910
- **koishi-element**: 基于 [Koishi 消息元素](https://koishi.chat/zh-CN/guide/basic/element.html),将模型的回复内容渲染为 Koishi 消息元素,输出到聊天平台上。
1011
- **voice**: 基于 [vits](https://github.com/initialencounter/2022-12-24/blob/neat/plugins/Tool/vits/readme.md) 服务,将模型的回复内容转换成语音输出。
1112
- **mixed-voice**: 基于 [vits](https://github.com/initialencounter/2022-12-24/blob/neat/plugins/Tool/vits/readme.md) 服务,将模型的回复内容转换成语音输出,同时也回复纯文本。
@@ -30,14 +31,12 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
3031
这类的消息元素,会被渲染为:
3132

3233
<chat-panel>
33-
3434
<chat-message nickname="Bot">
3535
<strong>@xx</strong> 你好
3636
</chat-message>
37-
3837
</chat-panel>
3938

40-
只需要让模型遵循 [这些](https://koishi.chat/zh-CN/api/message/syntax.html) 格式,就可以发送任意格式的文件,包括艾特,图片,语音,视频等。
39+
只需要让模型遵循 [这些](https://koishi.chat/zh-CN/api/message/syntax.html) 消息元素格式作为回复,就可以发送任意格式的消息元素。包括 AT,图片,语音,视频等。
4140

4241
## 语音输出
4342

@@ -49,7 +48,7 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
4948
可以使用 `impl:vits` 来搜寻实现了 `vits` 服务的插件。
5049
:::
5150

52-
具体配置请自行参考插件本身的主页,帮助等。
51+
具体配置请自行参考这些插件自身的主页,帮助等。
5352

5453
## 图片输出
5554

@@ -64,11 +63,11 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
6463
使用 [`chatluna.chat.text -t <mode>`](../useful-commands.md#直接对话) 命令进行聊天,`-t` 后面配上你的模式即可。
6564

6665
:::tip 提示
67-
使用 at 的响应无法进行单次设置输出模式
66+
使用 AT 的消息,无法设置单次输出模式
6867
:::
6968

7069
### 全局设置(推荐)
7170

7271
前往 Koishi 控制台,找到 ChatLuna 主插件的配置项,在 [`outputMode`](../useful-configurations.md#outputmode) 选项里选择你需要使用的输出模式即可。
7372

74-
这是全局的设置,也包括艾特的响应
73+
这是全局的设置,包括 AT 的其他模式的响应

docs/guide/chat-chain/stream.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 流式输出
22

3-
类似 ChatGPT 的打字机效果,ChatLuna 也进行了模拟,但并不是所有的 Koishi 聊天适配器都支持流式输出。所以我们有两种流式输出模式:
3+
类似 ChatGPT 的打字机效果,ChatLuna 也进行了模拟。
4+
5+
但并不是所有的 Koishi 聊天适配器都支持流式输出。所以我们有两种流式输出模式:
46

57
- 原生流式输出
68

docs/guide/chat-chain/text-censor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ChatLuna 基于 Koishi 的 [Censor 服务](https://censor.koishi.chat/plugins/te
1616

1717
## 使用
1818

19-
配置完成后正常使用即可ChatLuna 会自动调用 `censor` 服务进行文本审核。
19+
配置完成后正常使用即可ChatLuna 会自动调用 `censor` 服务进行文本审核。
2020

2121
![alt text](../../public/images/image-36.png)
2222

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
ChatLuna 使用嵌入模型来将用户的输入,模型的输出等数据转换为向量。
66

7-
目前,ChatLuna 通过 嵌入模型和 [向量数据库](../configure-vector-database/introduction.md) 来为用户提供 [长期记忆](guide/session-related/long-term-memory) 功能。
8-
97
嵌入模型的服务由多个插件提供,这其中某些模型适配器已经提供了相关服务,如 [OpenAI](./openai-embeddings.md)[Google Gemini](../configure-model-platform/google-gemini.md)
108

119
因此,你可以直接使用这些插件来使用嵌入模型服务,无需再安装嵌入模型服务插件。

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

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Claude
22

3-
Claude 是 Anthropic 公司推出的大语言模型,旗下同时开放 `claude-3.5-Sonnet`,`claude-3-haiku` 等模型。
3+
Claude 是 Anthropic 公司推出的大语言模型,旗下同时开放 `claude-4.5-Sonnet`,`claude-3.5-haiku` 等模型。
44

55
我们支持对接 Claude 里大部分可用的聊天大语言模型或嵌入模型。
66

7-
由于 API 限制,我们无法获取到 Claude 的最新模型列表。所以当 Claude 发布新模型时,我们滞后一段时间才会更新模型列表
7+
由于 API 限制,我们无法获取到 Claude 的最新模型列表。模型列表会滞后一段时间更新
88

99
## 安装
1010

@@ -32,21 +32,19 @@ Claude 是 Anthropic 公司推出的大语言模型,旗下同时开放 `claude
3232

3333
## 使用
3434

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

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

39-
![images](../../public/images/plugin_claude_config.png)
39+
<chat-panel>
40+
<chat-message nickname="User">chatluna.model.test claude-3-5-haiku-20241022</chat-message>
41+
<chat-message nickname="Bot">模型 claude/claude-3-5-haiku-20241022 测试成功!<br/>
42+
响应时间:2255ms<br/>
43+
示例回复:Hello! How can I assist you today?<br/>
44+
</chat-message>
45+
</chat-panel>
4046

41-
但我们仍未完全确认 Claude 适配器是否可用。
42-
43-
因此我们需要新建一个房间,使用 `chatluna.room.create -m claude/claude-3-haiku-20240307 -p chatgpt -n test-claude-adapter` 指令来创建一个使用了 Claude 适配器的房间。
44-
45-
新建房间后请尝试和模型对话。
46-
47-
只要能正常对话,就说明你成功的连接到了 Claude,接入了 Claude 适配器。
48-
49-
别忘了在测试完成后调用 `chatluna.room.delete test-claude-adapter` 指令删除测试房间。
47+
测试成功后,则代表你已成功接入 Claude 平台,可以正常使用了。
5048

5149
## 常见问题
5250

@@ -57,7 +55,7 @@ Claude 是 Anthropic 公司推出的大语言模型,旗下同时开放 `claude
5755
> [!TIP] 提示
5856
> 社区成员提供了免费的反向代理地址,使用反向代理地址无需开启代理模式,请在确认风险后使用。
5957
>
60-
> 使用方式:使用方式:将默认的 https://api.anthropic.com/v1 替换为以下地址。
58+
> 使用方式:使用方式:将默认的 <https://api.anthropic.com/v1> 替换为以下地址。
6159
>
6260
> 地址: [https://claude.api.2s.lol/v1](https://claude.api.2s.lol/v1)
6361
>

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DeepSeek
22

3-
DeepSeek 是一家专注于通用人工智能底层模型与技术研究的公司,成立于2023年,由知名私募巨头幻方量化创立。公司致力于探索人工智能的本质,发布了多个开源大模型,包括 DeepSeek-V3 通用大语言模型等。
3+
DeepSeek 是一家专注于通用人工智能底层模型与技术研究的公司,成立于 2023 年,由知名私募巨头幻方量化创立。公司致力于探索人工智能的本质,发布了多个开源大模型,包括 DeepSeek-V3 通用大语言模型等。
44

55
我们可以安装 `deepseek-adapter` 适配器来使用该公司提供的模型。
66

@@ -30,19 +30,25 @@ DeepSeek 是一家专注于通用人工智能底层模型与技术研究的公
3030
:::
3131

3232
获取到 API key 后,转到 `deepseek-adapter` 的配置页面。
33-
34-
当然,你也可以更改你喜欢的其他平台名。
3533

36-
完成后在请求设置里填入你的 API key 和 请求地址。请求地址应为 `https://api.deepseek.com/v1`
34+
在请求设置里填入你的 API key 和 请求地址。请求地址应为 `https://api.deepseek.com/v1`
3735

3836
![deepseek](../../public/images/image-12.png)
3937

4038
记得点击右上角的保存按钮。
4139

4240
## 使用
4341

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

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

48-
![deepseek](../../public/images/image-13.png)
46+
<chat-panel>
47+
<chat-message nickname="User">chatluna.model.test deepseek/deepseek-chat</chat-message>
48+
<chat-message nickname="Bot">模型 deepseek/deepseek-chat 测试成功!<br/>
49+
响应时间:5255ms<br/>
50+
示例回复:Hello! How can I assist you today?<br/>
51+
</chat-message>
52+
</chat-panel>
53+
54+
测试成功后,则代表你已成功接入 Deepseek 平台,可以正常使用了。

0 commit comments

Comments
 (0)