Skip to content

Commit 09e233d

Browse files
committed
docs(ecosystem): refine character message format in documentation
- Updated the character message structure in both markdown and YAML files to simplify the format by removing unnecessary attributes. - Clarified the expected content length for messages and provided examples for various message types, including replies and media attachments. - Enhanced the overall readability and consistency of the documentation regarding character interactions.
1 parent 9f04d55 commit 09e233d

2 files changed

Lines changed: 23 additions & 29 deletions

File tree

docs/ecosystem/other/character.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,44 +79,38 @@ system 是整个预设的核心部分。在默认预设中,基于类 yaml 的
7979
目前伪装使用类 xml 格式来表达消息,一条标准的消息如下:
8080

8181
```xml
82-
<message name='丛雨酱' id='0' type='type' sticker='sticker'>content</message>
82+
<message>content</message>
8383
```
8484

85-
其中 name 为群友的昵称,id 为群友的 id,type 为消息类型(支持 text 和 voice),sticker 为使用的标签,content 为消息内容。
85+
其中 name 为群友的昵称,id 为群友的 id,content 为消息内容。
8686

8787
伪装也支持让模型 AT 某个人,格式如下:
8888

8989
```xml
90-
<message name='丛雨酱' id='0' type='type' sticker='sticker'> <at name='name'>id</at> content </message>
90+
<message> <at name='name'>id</at> content </message>
9191
```
9292

9393
其中 name 为群友的昵称,id 为群友的 id,content 为消息内容。
9494

95-
颜文字或者其他自分段逻辑使用 `<pre>emo</pre>` 来表示。
96-
97-
示例:
95+
伪装还支持以下标签格式:
9896

99-
```xml
100-
<message name='丛雨酱' id='0' type='text' sticker='表情包类型'> <pre>(づ。◕‿‿◕。)づ</pre> 回复内容 <pre>(✿◠‿◠)</pre></message>
97+
```xml
98+
<message> <voice>语音内容</voice> </message>
99+
<message> <sticker>表情包链接(单独发送表情包)</sticker> </message>
100+
<message> <img>图片链接(图文混排)</img> </message>
101101
```
102102

103+
103104
在部分时候需要让角色不回复,则可以不填写 content 内容。
104105

105106
如:
106107

107108
```xml
108-
<message name='丛雨酱' id='0' type='text' sticker='表情包类型'></message>
109+
<message></message>
109110
```
110111

111112
具体的规则参考上面预设的格式。
112113

113-
> [!TIP] 提示
114-
> 伪装默认以 markdown 格式渲染模型生成的内容,并包含自带的分段逻辑。
115-
>
116-
> 如果你希望模型以原始格式输出内容,请让其生成的内容放入 `<pre>` 标签中。
117-
>
118-
> 在 pre 标签里,模型会使用原始的内容输出。(注意如果包含其他标签,则不会遵循此规则,如 pre 标签里包含 at 标签。)
119-
120114
你也可以任意自定义你的 `system` 内容。但需要注意的是,请让模型生成的内容遵循上面的回复格式。
121115

122116
### input
@@ -165,9 +159,9 @@ input 会把最近群聊的聊天记录和状态等信息作为格式化输入
165159
// 角色视角的思考过程
166160
</think>
167161

168-
<message_part>
169-
<message name='昵称在此处' id='0' type='text' sticker='表情包类型'>回复内容</message>
170-
</message_part>
162+
<output>
163+
<message>回复内容(10-20字,如果需要发送多条消息,请输出多个message标签)</message>
164+
</output>
171165
```
172166

173167
遵循上面的标准格式,伪装才能正常解析模型的回复。

docs/public/resources/character_preset.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@ input: |
4848
// 角色视角的思考过程
4949
</think>
5050
51-
<message_part>
52-
<message name='煕' id='0' type='text' sticker='表情包类型'>回复内容(40字内)</message>
53-
</message_part>
51+
<output>
52+
<message>回复内容(10-20字)</message>
53+
<message>回复内容2(可选,10-20字,如果需要发送多条消息,请输出多个message标签)</message>
54+
</output>
5455
5556
system: |
5657
你现在正在QQ群聊中和群友聊天,你是一个普通的群友。你的网名是煕,请根据以下信息进行角色扮演:
@@ -152,19 +153,18 @@ system: |
152153
153154
特殊元素: {{
154155
at: "<at name='name'>id</at>"
155-
颜文字: "<pre>emo</pre>"
156+
语音: "<voice>emo</voice>"
156157
}}
157158
158159
示例: {{
159-
普通回复: "<message name='煕' id='0' type='text' sticker='表情包类型'>回复内容</message>",
160-
At回复: "<message name='煕' id='0' type='text' sticker='表情包类型'><at name='用户'>123</at>回复内容</message>",
161-
带颜文字: "<message name='煕' id='0' type='text' sticker='表情包类型'><pre>(づ。◕‿‿◕。)づ</pre> 回复内容 <pre>(✿◠‿◠)</pre></message>",
162-
语音回复: "<message name='煕' id='0' type='voice' sticker='表情包类型'>语音内容</message>",
163-
无需回复: "<message name='煕' id='0' type='text' sticker='表情包类型'></message>"
160+
普通回复: "<message>回复内容</message>",
161+
At回复: "<message><at name='用户'>123</at>回复内容</message>",
162+
语音回复: "<message><voice>语音内容</voice></message>",
163+
无需回复: "<message></message>"
164164
}}
165165
166166
注意事项: {{
167-
1. 颜文字使用 <p> 标签包裹,多个颜文字间用空格分隔
167+
1. 每条消息只能包含 5 到 20 个字符,可以发送多条消息
168168
2. At 功能可在回复内容中使用多次
169169
3. 如不需要回复,返回空内容的消息
170170
}}

0 commit comments

Comments
 (0)