From 055b40f2ca6ec5b2abc3b9e72f1eaae522017d6f Mon Sep 17 00:00:00 2001 From: "Jing Y." <106428961+saltism@users.noreply.github.com> Date: Mon, 17 Mar 2025 17:11:26 +0800 Subject: [PATCH] Update metadata.mdx --- zh-cn/user-guide/knowledge-base/metadata.mdx | 312 +++++++++++-------- 1 file changed, 176 insertions(+), 136 deletions(-) diff --git a/zh-cn/user-guide/knowledge-base/metadata.mdx b/zh-cn/user-guide/knowledge-base/metadata.mdx index df2066ec..e9fdf7b2 100644 --- a/zh-cn/user-guide/knowledge-base/metadata.mdx +++ b/zh-cn/user-guide/knowledge-base/metadata.mdx @@ -6,43 +6,34 @@ title: 元数据 ### 定义 -元数据是用于描述其他数据的信息。简单来说，它是"关于数据的数据"。它就像一本书的目录或标签，可以为你介绍数据的内容、来源和用途。 +元数据是用于描述其他数据的信息。简单来说，它是“关于数据的数据”。它就像一本书的目录或标签，可以为你介绍数据的内容、来源和用途。 通过提供数据的上下文，元数据能帮助你在知识库内快速查找和管理数据。 ### 知识库元数据定义 -- **字段（Field）**：元数据字段是用于描述文档特定属性的标识项，每个字段代表文档的某个特征或信息。例如"author""language"等。 +- **字段（Field）**：元数据字段是用于描述文档特定属性的标识项，每个字段代表文档的某个特征或信息。例如“author”“language”等。 -- **字段值（Value）**：字段值是该字段的具体信息或属性，例如"Jack""English"。 +- **字段值（Value）**：字段值是该字段的具体信息或属性，例如“Jack”“English”。 -field_name_and_value +

+ field_name_and_value +

-- **字段值计数（Value Count）**：字段值计数是指在某条元数据字段中标记的字段值数量，包括重复项。例如，此处的"3"是字段值计数，指该字段中有 3 个独特的字段值。 +- **字段值计数（Value Count）**：字段值计数是指在某条元数据字段中标记的字段值数量，包括重复项。例如，此处的“3”是字段值计数，指该字段中有 3 个独特的字段值。 - +

+ metadata_field +

- **值类型（Value Type）**：值类型指字段值的类型。 - - 目前，Dify 的元数据功能支持以下三种值类型： - - **字符串**（String）：文本值。 - - **数字**（Number）：数值。 - - **时间**（Time）：日期和时间。 + - 目前，Dify 的元数据功能支持以下三种值类型： + - **字符串**（String）：文本值。 + - **数字**（Number）：数值。 + - **时间**（Time）：日期和时间。 -value_type +

+ value_type +

## 如何管理知识库元数据？ @@ -66,15 +57,63 @@ alt="metadata_field" 在知识库中，元数据字段分为两类：**内置元数据（Built-in）** 和 **自定义元数据**。 -| | 内置元数据（Built-in） | 自定义元数据 | -| --- | --- | --- | -| 显示位置 | 知识库界面 元数据 栏的下半部分。 | 知识库界面 元数据 栏的上半部分。 | -| 启用方式 | 默认禁用，需要手动开启才能生效。 | 由用户根据需求自由添加。 | -| 生成方式 | 启用后，由系统自动提取相关信息并生成字段值。 | 用户手动添加，完全由用户自定义。 | -| 修改权限 | 一旦生成，无法修改字段与字段值。 | 可以删除或编辑字段名称，也可以修改字段值。 | -| 应用范围 | 启用后，适用于已上传和新上传的所有文档。 | 添加元数据字段后，字段会储存在知识库的元数据列表中/需要手动设置，才能将该字段应用于具体文档。 | -| 字段 | 由系统预定义，包括：• document_name (string)：文件名• uploader (string)：上传者• upload_date (time)：上传日期• last_update_date (time)：最后更新时间• source (string)：文件来源 | 在初始状态下，知识库无自定义元数据字段，需要用户手动添加。 | -| 字段值类型 | • 字符串 (string)：文本值• 数字 (number)：数值• 时间 (time)：日期和时间 | • 字符串 (string)：文本值• 数字 (number)：数值 • 时间 (time)：日期和时间 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
内置元数据（Built-in）自定义元数据
显示位置知识库界面 元数据 栏的下半部分。知识库界面 元数据 栏的上半部分。
启用方式默认禁用，需要手动开启才能生效。由用户根据需求自由添加。
生成方式启用后，由系统自动提取相关信息并生成字段值。用户手动添加，完全由用户自定义。
修改权限一旦生成，无法修改字段与字段值。可以删除或编辑字段名称，也可以修改字段值。
应用范围启用后，适用于已上传和新上传的所有文档。添加元数据字段后，字段会储存在知识库的元数据列表中/需要手动设置，才能将该字段应用于具体文档。
字段 + 由系统预定义，包括：
+ • document_name (string)：文件名
+ • uploader (string)：上传者
+ • upload_date (time)：上传日期
+ • last_update_date (time)：最后更新时间
+ • source (string)：文件来源 + 		在初始状态下，知识库无自定义元数据字段，需要用户手动添加。
字段值类型 + • 字符串 (string)：文本值
+ • 数字 (number)：数值
+ • 时间 (time)：日期和时间 + 		+ • 字符串 (string)：文本值
+ • 数字 (number)：数值
+ • 时间 (time)：日期和时间 +
#### 新建元数据字段 @@ -88,11 +127,9 @@ alt="metadata_field" > 字段名仅支持小写字母、数字和下划线（_）字符，不支持空格和大写字母。 -value_type +

+ value_type +

4. 点击 **保存** 按钮，保存字段。 @@ -108,11 +145,9 @@ alt="metadata_field" > 此弹窗仅支持修改字段名称，不支持修改字段值类型。 -rename_field_2 +

+ rename_field_2 +

3. 点击 **保存** 按钮，保存修改后的字段。 @@ -148,57 +183,33 @@ alt="metadata_field" 1. 在 **编辑元数据** 弹窗中点击底部的 **+添加元数据** 按钮，弹出操作弹窗。 -add_metadata +

add_metadata

- 如需为选中文档添加已创建的字段： - - 可以从下拉列表中选择已有的字段，添加到字段列表中。 - - - 可以在 **搜索元数据** 搜索框中搜索你需要的字段，添加到该文档的字段列表中。 - -existing_field + - 可以从下拉列表中选择已有的字段，添加到字段列表中。 + + - 可以在 **搜索元数据** 搜索框中搜索你需要的字段，添加到该文档的字段列表中。 + +

existing_field

- 如需为选中文档新建字段，可以点击弹窗左下角的 **+新建元数据** 按钮，并参考前文的 **新建元数据字段** 章节新建字段。 - - > 在 **+新建元数据** 弹窗中新建的元数据字段，将自动同步至知识库字段列表中。 + + > 在 **+新建元数据** 弹窗中新建的元数据字段，将自动同步至知识库字段列表中。 -new_metadata_field - +

new_metadata_field

+ - 如需管理已创建的字段，可以点击该弹窗右下角的 **管理** 按钮，跳转到知识库的管理界面。 -manage_field +

manage_field

2. *（可选）* 新增字段后，在字段值框内填写该字段相应的字段值。 -value_for_field +

value_for_field

- 如果值类型为 **时间**，在填写字段值时会弹出时间选择器，供你选择具体时间。 -date_picker +

date_picker

3. 点击 **保存** 按钮，保存操作。 @@ -210,33 +221,21 @@ alt="metadata_field" - **重置字段值**： 将光标悬停在字段名左侧的蓝色圆点上，蓝点将变为 **重置** 按钮。点击蓝点，将字段框内修改后的内容重置为原始元数据值。 -reset_values +

reset_values

- **删除字段值**： - - 删除一个字段值：在需要删除字段值的字段框内直接删除该字段值。 + - 删除一个字段值：在需要删除字段值的字段框内直接删除该字段值。 - - 删除多个字段值：点击 **多个值** 卡片的删除图标，清空所有选中文档的该元数据字段的值。 + - 删除多个字段值：点击 **多个值** 卡片的删除图标，清空所有选中文档的该元数据字段的值。 -multiple_values +

multiple_values

- **删除单条元数据字段**： 点击字段最右侧的删除符号，删除该字段。删除后，该字段会被横线划掉且置灰。 - - > 此操作仅会删除已选文档的该字段与字段值，字段本身依然保留在知识库中。 + + > 此操作仅会删除已选文档的该字段与字段值，字段本身依然保留在知识库中。 -delete_fields +

delete_fields

2. 点击 **保存** 按钮，保存操作。 @@ -244,15 +243,11 @@ alt="metadata_field" - **调整批量操作的应用范围**： 你可以使用 **编辑元数据** 弹窗左下角的 **应用于所有文档** 选框来调整编辑模式中改动的应用范围。 -- **否（默认）**： 如果不选中该选项，编辑模式中的改动仅对原本已有该元数据字段的文档生效，其他文档不会受到影响。 + - **否（默认）**： 如果不选中该选项，编辑模式中的改动仅对原本已有该元数据字段的文档生效，其他文档不会受到影响。 -- **是**： 如果选中该选项，编辑模式中的改动会对所有选中的文档生效。原本没有该字段的文档，会自动添加该字段。 + - **是**： 如果选中该选项，编辑模式中的改动会对所有选中的文档生效。原本没有该字段的文档，会自动添加该字段。 -apply_all_changes +

apply_all_changes

#### 编辑单篇文档元数据信息 @@ -273,23 +268,23 @@ alt="metadata_field" 1. 在文档的元数据编辑模式中，点击 **+添加元数据** 按钮，弹出操作弹窗。 ![add_metadata](https://assets-docs.dify.ai/2025/03/f9ba9b10bbcf6eaca787eed4fcde44da.png) - - 如需使用新建字段为该文档标记字段值，可以点击弹窗左下角的 **+ 新建元数据** 按钮，并参考前文的 **新建元数据字段** 章节新建字段。 +- 如需使用新建字段为该文档标记字段值，可以点击弹窗左下角的 **+ 新建元数据** 按钮，并参考前文的 **新建元数据字段** 章节新建字段。 - > 在文档页面新建的元数据字段，将自动同步至知识库字段列表中。 - - ![new_fields](https://assets-docs.dify.ai/2025/03/739e7e51436259fca45d16065509fabb.png) + > 在文档页面新建的元数据字段，将自动同步至知识库字段列表中。 + + ![new_fields](https://assets-docs.dify.ai/2025/03/739e7e51436259fca45d16065509fabb.png) - - 如需使用知识库已有的字段为该文档标记字段值，可以选择下列任意一种方式使用已有的字段： +- 如需使用知识库已有的字段为该文档标记字段值，可以选择下列任意一种方式使用已有的字段： - - 从下拉列表中选择知识库已有的字段，添加到该文档的字段列表中。 + - 从下拉列表中选择知识库已有的字段，添加到该文档的字段列表中。 - - 在 **搜索元数据** 搜索框中搜索你需要的字段，添加到该文档的字段列表中。 - + - 在 **搜索元数据** 搜索框中搜索你需要的字段，添加到该文档的字段列表中。 + ![existing_fields](https://assets-docs.dify.ai/2025/03/5b1876e8bc2c880b3b774c97eba371ab.png) - - 如需管理知识库已有的字段，可以点击弹窗右下角的 **管理** 按钮，跳转到知识库的管理界面。 +- 如需管理知识库已有的字段，可以点击弹窗右下角的 **管理** 按钮，跳转到知识库的管理界面。 - ![manage_metadata](https://assets-docs.dify.ai/2025/03/8dc74a1d2cdd87294e58dbc3d6dd161b.png) + ![manage_metadata](https://assets-docs.dify.ai/2025/03/8dc74a1d2cdd87294e58dbc3d6dd161b.png) 2. *（可选）* 添加字段后，在字段名右侧的元数据栏中填写字段值。 @@ -304,13 +299,13 @@ alt="metadata_field" ![edit_mode](https://assets-docs.dify.ai/2025/03/bb33a0f9c6980300c0f979f8dc0d274d.png) 2. 删改文档元数据信息： - - **删改字段值**： 在字段名右侧的字段值框内，删除或修改字段值。 + - **删改字段值**： 在字段名右侧的字段值框内，删除或修改字段值。 - > 此模式仅支持修改字段值，不支持修改字段名。 + > 此模式仅支持修改字段值，不支持修改字段名。 - - **删除字段**： 点击字段值框右侧的删除按钮，删除字段。 + - **删除字段**： 点击字段值框右侧的删除按钮，删除字段。 - > 此操作仅会删除该文档的该字段与字段值，字段本身依然保留在知识库中。 + > 此操作仅会删除该文档的该字段与字段值，字段本身依然保留在知识库中。 ![edit_metadata](https://assets-docs.dify.ai/2025/03/4c0c4d83d3ad240568f316abfccc9c2c.png) @@ -328,25 +323,70 @@ alt="metadata_field" - **元数据有什么作用？** - - 提升搜索效率：用户可以根据元数据标签快速筛选和查找相关信息，节省时间并提高工作效率。 + - 提升搜索效率：用户可以根据元数据标签快速筛选和查找相关信息，节省时间并提高工作效率。 - - 增强数据安全性：通过元数据设置访问权限，确保只有授权用户能访问敏感信息，保障数据的安全性。 + - 增强数据安全性：通过元数据设置访问权限，确保只有授权用户能访问敏感信息，保障数据的安全性。 - - 优化数据管理能力：元数据帮助企业或组织有效分类和存储数据，提高数据的管理和检索能力，增强数据的可用性和一致性。 + - 优化数据管理能力：元数据帮助企业或组织有效分类和存储数据，提高数据的管理和检索能力，增强数据的可用性和一致性。 - - 支持自动化流程：元数据在文档管理、数据分析等场景中可以自动触发任务或操作，简化流程并提高整体效率。 + - 支持自动化流程：元数据在文档管理、数据分析等场景中可以自动触发任务或操作，简化流程并提高整体效率。 - **知识库元数据管理列表中的元数据字段和某篇文档中的元数据值有什么区别？** -| / | 定义 | 性质 | 举例 | -| --- | --- | --- | --- | -| 元数据管理列表中的元数据字段 | 预定义的字段，用于描述文档的某些属性。 | 全局性字段。所有文档都可以使用这些字段。 | 作者、文档类型、上传日期。 | -| 某篇文档中的元数据值 | 每个文档按需标记的针对特定文档的信息。 | 文档特定的值。每个文档根据其内容会标记不同的元数据值。 | 文档 A 的"作者"字段值为"张三"，文档 B 的"作者"字段值为"李四"。 | + + + + + + + + + + + + + + + + + + + + + + + +
/定义性质举例
元数据管理列表中的元数据字段预定义的字段，用于描述文档的某些属性。全局性字段。所有文档都可以使用这些字段。作者、文档类型、上传日期。
某篇文档中的元数据值每个文档按需标记的针对特定文档的信息。文档特定的值。每个文档根据其内容会标记不同的元数据值。文档 A 的“作者”字段值为“张三”，文档 B 的“作者”字段值为“李四”。
-- **"在知识库管理界面删除某条元数据字段""在编辑元数据弹窗中删除已选文档的某条元数据字段"和"在文档详情界面删除某条元数据字段"有什么区别？** +- **“在知识库管理界面删除某条元数据字段”“在编辑元数据弹窗中删除已选文档的某条元数据字段”和“在文档详情界面删除某条元数据字段”有什么区别？** -| 操作方式 | 操作方法 | 示例图 | 影响范围 | 结果 | -| --- | --- | --- | --- | --- | -| 在知识库管理界面删除某条元数据字段 | 在知识库管理界面，点击某条元数据字段右侧的删除图标，删除该字段。 | ![knowledge_base_delete](https://assets-docs.dify.ai/2025/03/13367a865d589a29b7c4098526fad5dc.png) | 从知识库管理列表中完全删除该元数据字段及其所有字段值。 | 该字段从知识库中移除，所有文档中的该字段及包含的所有字段值也会消失。 | -| 在编辑元数据弹窗中删除已选文档的某条元数据字段 | 在编辑元数据弹窗中，点击某条元数据字段右侧的删除图标，删除该字段。 | ![bulk_delete](https://assets-docs.dify.ai/2025/03/ed8c9143ba9a8eae6efcb76e309dbec1.png) | 仅删除已选文档的该字段与字段值，字段本身依然保留在知识库管理列表中。 | 选中文档中的字段与字段值被移除，但字段仍保留在知识库内，字段值计数会发生数值上的变化。 | -| 在文档详情界面删除某条元数据字段 | 在文档详情界面中的元数据编辑模式里，点击某条元数据字段右侧的删除图标，删除该字段。 | ![single_delete](https://assets-docs.dify.ai/2025/03/19d7fe886dd30a3f3322fa2a87f87203.png) | 仅删除该文档的该字段与字段值，字段本身依然保留在知识库管理列表中。 | 该文档中的字段与字段值被移除，但字段仍保留在知识库内，字段值计数会发生数值上的变化。 | \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
操作方式操作方法影响范围结果
在知识库管理界面删除某条元数据字段在知识库管理界面，点击某条元数据字段右侧的删除图标，删除该字段。从知识库管理列表中完全删除该元数据字段及其所有字段值。该字段从知识库中移除，所有文档中的该字段及包含的所有字段值也会消失。
在编辑元数据弹窗中删除已选文档的某条元数据字段在编辑元数据弹窗中，点击某条元数据字段右侧的删除图标，删除该字段。仅删除已选文档的该字段与字段值，字段本身依然保留在知识库管理列表中。选中文档中的字段与字段值被移除，但字段仍保留在知识库内，字段值计数会发生数值上的变化。
在文档详情界面删除某条元数据字段在文档详情界面中的元数据编辑模式里，点击某条元数据字段右侧的删除图标，删除该字段。仅删除该文档的该字段与字段值，字段本身依然保留在知识库管理列表中。该文档中的字段与字段值被移除，但字段仍保留在知识库内，字段值计数会发生数值上的变化。