Skip to content

Commit bd1deef

Browse files
committed
Update documentation for improved clarity and usability
1 parent 4dcdccb commit bd1deef

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

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

Lines changed: 21 additions & 0 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+
- **koishi-element**: 基于 [Koishi 消息元素](https://koishi.chat/zh-CN/guide/basic/element.html),将模型的回复内容渲染为 Koishi 消息元素,输出到聊天平台上。
910
- **voice**: 基于 [vits](https://github.com/initialencounter/2022-12-24/blob/neat/plugins/Tool/vits/readme.md) 服务,将模型的回复内容转换成语音输出。
1011
- **mixed-voice**: 基于 [vits](https://github.com/initialencounter/2022-12-24/blob/neat/plugins/Tool/vits/readme.md) 服务,将模型的回复内容转换成语音输出,同时也回复纯文本。
1112

@@ -18,6 +19,26 @@ ChatLuna 针对模型的输出提供了一套渲染 API,可以方便的将模
1819

1920
前面内置的格式,除了语音输出,其他都无需配置。
2021

22+
## 消息元素渲染输出
23+
24+
消息元素渲染输出会将模型的回复内容渲染为 Koishi 消息元素,输出到聊天平台上。例如:
25+
26+
```tsx
27+
<at id='xx' /> 你好
28+
```
29+
30+
这类的消息元素,会被渲染为:
31+
32+
<chat-panel>
33+
34+
<chat-message nickname="Bot">
35+
<strong>@xx</strong> 你好
36+
</chat-message>
37+
38+
</chat-panel>
39+
40+
只需要让模型遵循 [这些](https://koishi.chat/zh-CN/api/message/syntax.html) 格式,就可以发送任意格式的文件,包括艾特,图片,语音,视频等。
41+
2142
## 语音输出
2243

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

0 commit comments

Comments
 (0)