From d4fded75379452d20a06d8a7089def61f327abb8 Mon Sep 17 00:00:00 2001 From: dingyi Date: Sun, 6 Oct 2024 19:50:17 +0800 Subject: [PATCH] docs(preset-system): improve World Book documentation clarity - Enhance the World Book section with clearer headings and explanations - Add distinction between default configuration and main entry configuration - Improve readability and structure of the content for better understanding --- docs/guide/configure-model-platform/zhipu.md | 0 docs/guide/preset-system/write-preset.md | 14 ++++++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 docs/guide/configure-model-platform/zhipu.md diff --git a/docs/guide/configure-model-platform/zhipu.md b/docs/guide/configure-model-platform/zhipu.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/guide/preset-system/write-preset.md b/docs/guide/preset-system/write-preset.md index 9a9493d0..16a82ad2 100644 --- a/docs/guide/preset-system/write-preset.md +++ b/docs/guide/preset-system/write-preset.md @@ -127,7 +127,9 @@ text{variable_name} | {variable_name::xx::xx} | {variable_name:xx,xx,xx} ### 世界书 -World Book （或称 Lorebooks）是 ChatLuna 的特色功能之一，它允许你为你的预设编写一系列信息，并且通过关键词在合适的时机插入这些信息。 +## 世界书 + +World Book（或称 Lorebooks）是 ChatLuna 的特色功能之一，它允许你为你的预设编写一系列信息，并且通过关键词在合适的时机插入这些信息。 下面是一个示例： @@ -145,16 +147,20 @@ world_lores: content: 你好啊，旅行者。我很高兴能再次见到你。你今天有什么新奇的发现吗？我很想听听。 ``` -我们逐步讲解这些属性： +让我们逐步讲解这些属性： + +### 默认配置项 -对于第一个没有 `keywords` 的 `world_lore` 的项目，这代表着这个世界书的默认配置项，以下是可用的配置项： +对于第一个没有 `keywords` 的 `world_lore` 子项，这代表世界书的默认配置项，以下是可用的配置项： - `scanDepth`: 扫描深度，代表着会扫描多深的聊天信息。当设置为 0 时，不会扫描任何聊天信息，设置为 1 时，会扫描最近 1 条聊天信息，设置为 2 时，会扫描最近 2 条聊天信息，以此类推。 - `tokenLimit`: 当所有扫描后可用的世界书信息总 token 数超过这个值时，会停止扫描。 - `recursiveScan`: 是否递归扫描。递归扫描意味着世界书条目类的内容可以继续触发其他的世界书条目类。 - `maxRecursionDepth`: 最大递归深度。当设置为 3 时，会递归扫描 3 层世界书条目类。 -对于第二个有 `keywords` 的 `world_lore` 的项目或者其他 `world_lore` 的项目，这代表着这个世界书的主要条目类，以下是可用的配置项： +### 主要条目配置 + +对于第二个有 `keywords` 的 `world_lore` 子项或者其他 `world_lore` 子项，这代表世界书的主要条目类，以下是可用的配置项（会覆盖默认配置项）： - `keywords`: 关键词，代表着触发世界书条目类的关键词。可以使用正则表达式来匹配关键词。 - `content`: 内容，代表着当扫描到关键词的聊天信息时，会插入的内容。