1
 1|# 连接外部知识库
2
 2|
3
 3|> 原文：[连接外部知识库](https://docs.dify.ai/zh/use-dify/knowledge/connect-external-knowledge-base)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/connect-external-knowledge-base)。
11
11|
12
12|如果你的团队自建 RAG 系统，或将内容托管在第三方知识服务（如[AWS Bedrock](https://aws.amazon.com/bedrock/)）中，你可将这些外部知识源连接到 Dify，无需将内容迁移至 Dify 内置的知识库。
13
13|
14
14|这样，你的 AI 应用可直接从现有基础设施中检索信息，同时你可完全掌控检索逻辑和内容管理。
15
15|
16
16|
17
17|** 连接外部知识库包含三个步骤 **：
18
18|
19
19|
20
20|- [构建一个供 Dify 查询的 API 服务](#step-1-%E6%9E%84%E5%BB%BA%E6%A3%80%E7%B4%A2-api)。
21
21|- [在 Dify 中注册 API 端点](#step-2-%E6%B3%A8%E5%86%8C%E5%A4%96%E9%83%A8%E7%9F%A5%E8%AF%86%E5%BA%93-api)。
22
22|- [通过已注册的 API 连接特定知识源](#step-3-%E5%88%9B%E5%BB%BA%E5%A4%96%E9%83%A8%E7%9F%A5%E8%AF%86%E5%BA%93)。应用运行时，Dify 向你的端点发送检索请求，并将返回的分段作为 LLM 响应的上下文。
23
23|
24
24|
25
25|> 💡 如果你要连接 LlamaCloud，可直接安装[LlamaCloud 插件](https://marketplace.dify.ai/plugin/langgenius/llamacloud) 而无需构建自定义 API。完整的设置演示详见[视频教程](https://www.youtube.com/watch?v=FaOzKZRS-2E)。
26
26|
27
27|如果你正在为其他知识服务构建插件，可参考 LlamaCloud 插件的[源代码](https://github.com/langgenius/dify-official-plugins/tree/main/extensions/llamacloud)。
28
28|
29
29|
30
30|> 💡 Dify 对外部知识库仅拥有检索权限，无法修改或管理你的外部内容。你需要独立维护外部知识库及其检索逻辑。
31
31|
32
32|
33
33|## Step 1: 构建检索 API 构建一个实现[外部知识库 API 规范](/zh/use-dify/knowledge/external-knowledge-api) 的 API 服务。该服务需提供一个`POST`端点，接受搜索查询并返回匹配的文本分段及相似度分数。
34
34|
35
35|
36
36|## Step 2: 注册外部知识库 API 外部知识库 API 用于存储你的端点 URL 和认证凭据。多个知识库可共享同一个 API 连接。
37
37|
38
38|
39
39|- 前往 ** 知识库 **，点击右上角的 ** 外部知识库 API**，然后点击 ** 添加外部知识库 API**。
40
40|
41
41|
42
42|- 填写以下字段：
43
43|
44
44|
45
45|- ** 名称 **：用于区分不同 API 连接的标签。
46
46|- **API 接口地址 **：外部知识服务的基础 URL。Dify 发送请求时自动追加`/retrieval`。
47
47|- **API Key**：认证凭据。Dify 将其作为 Bearer 令牌放在`Authorization`请求头中发送。保存时，Dify 向你的端点发送测试请求以验证连接。
48
48|
49
49|
50
50|## Step 3: 创建外部知识库注册 API 后，将外部知识源连接到 Dify。这会在 Dify 中创建一个与你的外部系统关联的知识库。
51
51|
52
52|
53
53|- 前往 ** 知识库 **，点击 ** 连接外部知识库 **。
54
54|
55
55|
56
56|- 填写以下字段：
57
57|
58
58|
59
59|- ** 外部知识库名称 ** 和 ** 知识库描述 **（可选）。
60
60|
61
61|
62
62|- ** 外部知识库 API**：选择你已注册的 API 连接。
63
63|
64
64|
65
65|- ** 外部知识库 ID**：外部系统中特定知识源的标识符，作为`knowledge_id`字段传递给你的 API。
66
66|
67
67|这个 ID 是你的外部服务用于区分不同知识库的标识符。例如，Bedrock 知识库的 ARN，或者你在自己系统中定义的 ID。
68
68|
69
69|
70
70|> ⚠️ ** 外部知识库 API** 和 ** 外部知识库 ID** 创建后不可更改。如需使用其他 API 或知识源，请创建新的外部知识库。
71
71|
72
72|
73
73|- ** 检索设置 **：
74
74|
75
75|
76
76|- **Top K**：每次查询检索的最大分段数。数值越高，返回的结果越多，但可能包含相关性较低的内容。
77
77|
78
78|
79
79|- ** 分数阈值 **：返回分段的最低相似度分数。启用此选项可过滤掉低相关性的结果。数值越高，相关性要求越严格；数值越低，匹配范围越广。
80
80|
81
81|禁用时，无论分数如何，均返回 Top K 限制内的所有结果。
82
82|
83
83|创建完成后，即可在你的应用中使用外部知识库，用法与内置知识库相同。详见[在应用内集成知识库](/zh/use-dify/knowledge/integrate-knowledge-within-application)。
84
84|
85
85|
86
86|## 常见问题
87
87|### 连接被拒绝或超时（自托管环境）Dify 通过基于 Squid 的 SSRF 代理路由出站 HTTP 请求。如果你的外部知识服务与 Dify 运行在同一主机上，或其域名未添加到白名单中，代理会阻止该请求。
88
88|
89
89|要允许连接，请将你的服务域名添加到`docker/ssrf_proxy/squid.conf.template`的`allowed_domains`ACL 中：
90
90|
91
91|
92
92|```
93
93|`acl allowed_domains dstdomain .marketplace.dify.ai .your-kb-service.com
94
94|`
95
95|```
96
96|编辑后请重启 SSRF 代理容器。
97
97|
98
98|
99
99|### API 响应格式问题如果检索失败或返回意外结果，请根据[外部知识库 API 规范](/zh/use-dify/knowledge/external-knowledge-api#%E5%93%8D%E5%BA%94) 验证你的 API 响应。

1
 1|# 指定分段设置
2
 2|
3
 3|> 原文：[指定分段设置](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text)。
11
11|
12
12|
13
13|## 什么是分段？导入知识库的文档会被拆分为较小的片段，称为 ** 分段 **。分段的概念类似于将一本大书整理成章节和段落——你无法在一大块文本中快速找到特定信息，但组织良好的章节能使检索变得高效。
14
14|
15
15|当用户提出问题时，系统会在这些分段中搜索相关信息，并将其作为上下文提供给 LLM。如果没有分段，每次查询都需要处理整个文档，这将既缓慢又低效。
16
16|
17
17|** 关键分段参数 **
18
18|
19
19|
20
20|- ** 分隔符 **：文本被拆分的字符或字符序列。例如，`\n\n`在段落换行处拆分，`\n`在行换行处拆分。
21
21|
22
22|
23
23|> ⚠️ 分隔符在分段过程中会被移除。例如，使用`A`作为分隔符会将`CBACD`拆分为`CB`和`CD`。
24
24|
25
25|为避免信息丢失，请使用文档中不会自然出现的非内容字符。
26
26|
27
27|
28
28|- ** 分段最大长度 **：每个分段的最大字符数。超过此限制的文本将被强制拆分，无论分隔符设置如何。
29
29|
30
30|
31
31|## 通用模式与父子模式
32
32|> ⚠️ 知识库创建后，分段模式无法更改。但分隔符和分段最大长度等分段设置可以随时调整。
33
33|
34
34|
35
35|### 模式概述
36
36|- 通用模式
37
37|- 父子模式:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0" data-component-part="tab-content"> 在通用模式下，所有分段共享相同的设置。匹配的分段将直接作为检索结果返回。
38
38|
39
39|** 分段设置 **
40
40|
41
41|除了分隔符和分段最大长度外，你还可以配置 ** 分段重叠长度 ** 来指定相邻分段之间重叠的字符数。这有助于保持语义连接，防止重要信息被拆分到不同的分段边界。
42
42|
43
43|例如，设置 50 个字符的重叠，一个分段的最后 50 个字符也会出现在下一个分段的前 50 个字符中。
44
44|
45
45|:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0 hidden" data-component-part="tab-content"> 在父子模式下，文本被拆分为两层：较小的 ** 子分段 ** 和较大的 ** 父分段 **。当查询匹配到子分段时，其整个父分段将作为检索结果返回。
46
46|
47
47|这解决了一个常见的检索困境：较小的分段能够实现精确的查询匹配但缺乏上下文，而较大的分段提供丰富的上下文但降低了检索准确性。
48
48|
49
49|父子模式兼顾两者——以精准检索，以上下文响应。
50
50|
51
51|** 父分段设置 **
52
52|
53
53|父分段可以在 ** 段落 ** 或 ** 全文 ** 模式下创建。
54
54|
55
55|
56
56|- 段落
57
57|- 全文:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0" data-component-part="tab-content"> 文档根据指定的分隔符和分段最大长度被拆分为多个父分段。
58
58|
59
59|适用于结构良好的长文档，其中每个部分都能独立提供有意义的上下文。
60
60|
61
61|:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0 hidden" data-component-part="tab-content"> 整个文档作为单个父分段。
62
62|
63
63|适用于小型、内容紧密的文档，其中完整的上下文对于理解任何具体细节都是必要的。
64
64|
65
65|
66
66|> ⚠️ 在 ** 全文 ** 模式下：
67
67|
68
68|
69
69|- 仅处理前 10,000 个 token。超出此限制的内容将被截断。
70
70|
71
71|
72
72|- 父分段创建后无法编辑。如需修改，必须上传新文档。
73
73|
74
74|
75
75|** 子分段设置 **
76
76|
77
77|每个父分段会使用其自己的分隔符和分段最大长度设置进一步拆分为子分段。
78
78|
79
79|
80
80|> ⚠️ 避免为父分段和子分段使用互为子集的分隔符，因为这可能导致意外的分段行为。
81
81|
82
82|例如，推荐使用`??`和`##`，而不是`??`和`?`。
83
83|
84
84|
85
85|### 快速对比维度通用模式父子模式分段策略单层：所有分段使用相同设置双层：父分段和子分段分别设置检索流程匹配的分段直接返回子分段用于匹配查询；父分段返回以提供更广泛的上下文兼容的[索引方式](/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods) 高质量、经济仅高质量最佳适用场景简单、独立的内容，如术语表或常见问题信息密集型文档，如技术手册或研究论文，上下文很重要
86
86|## 分段前的文本预处理在将文本拆分为分段之前，你可以清理无关内容以提高检索质量。
87
87|
88
88|
89
89|- ** 替换连续的空格、换行符和制表符 **
90
90|
91
91|
92
92|- 三个或更多连续换行符 → 两个换行符
93
93|
94
94|
95
95|- 多个空格 → 单个空格
96
96|
97
97|
98
98|- 制表符、换页符和特殊 Unicode 空格 → 普通空格
99
99|

1
 1|# 上传本地文件
2
 2|
3
 3|> 原文：[上传本地文件](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/import-text-data/readme)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/import-text-data/readme)。
11
11|
12
12|
13
13|> ⚠️ 知识库创建后，其数据源无法更改。
14
14|
15
15|
16
16|快速创建知识库时，可上传本地文件作为其数据源：
17
17|
18
18|
19
19|- 点击 ** 知识库 **>** 创建知识库 **。
20
20|
21
21|
22
22|- 选择 ** 导入已有文本 ** 作为数据源，然后上传文件。
23
23|
24
24|
25
25|- 单次最多可上传 5 个文件
26
26|
27
27|
28
28|> 💡 在 Dify Cloud 上，仅[付费套餐](https://dify.ai/zh/pricing) 支持 ** 批量上传 **（单次最多 50 个文件）。
29
29|
30
30|
31
31|- 单个文件最大支持 15 MB
32
32|
33
33|
34
34|> 💡 对于自托管部署，可通过环境变量`UPLOAD_FILE_SIZE_LIMIT`和`UPLOAD_FILE_BATCH_LIMIT`调整这两个限制。
35
35|
36
36|
37
37|** 对于文件中的图片 **
38
38|
39
39|JPG、JPEG、PNG 和 GIF 格式且小于 2 MB 的图片将作为附件，自动提取到对应的分段。这些图片可独立管理，并在检索时与分段一同返回。
40
40|
41
41|提取的图片 URL 会保留在分段文本中，但你可以放心删除这些 URL 以保持文本整洁——这不会影响已提取的图片。
42
42|
43
43|若在索引设置中选择多模态嵌入模型（带有 **Vision** 图标），则提取出的图片也将被向量化并索引以供检索。
44
44|
45
45|每个分段最多支持 10 个图片附件，超出的图片不会被提取。
46
46|
47
47|
48
48|> 💡 对于自托管部署，可通过环境变量调整以下限制：
49
49|
50
50|
51
51|- 最大图片尺寸：`ATTACHMENT_IMAGE_FILE_SIZE_LIMIT`
52
52|
53
53|
54
54|- 每个分段的最大附件数量：`SINGLE_CHUNK_ATTACHMENT_LIMIT`
55
55|
56
56|
57
57|以上提取规则适用于如下图片类型：
58
58|
59
59|
60
60|- DOCX 文件中嵌入的图片
61
61|
62
62|
63
63|> 💡 其他文件类型（如 PDF）中嵌入的图片，可通过在[知识流水线](/zh/use-dify/knowledge/knowledge-pipeline/readme) 中使用合适的文档提取插件进行提取。
64
64|
65
65|
66
66|- 在任何文件类型中，通过以下 Markdown 语法引用、URL 可访问的图片：
67
67|
68
68|
69
69|- `![alt text](image_url)`
70
70|- `![alt text](image_url "optional title")`
71
71|

1
 1|# 从 Notion 导入数据
2
 2|
3
 3|> 原文：[从 Notion 导入数据](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion)。
11
11|
12
12|Dify 知识库支持从 Notion 导入，并支持后续的数据自动同步。
13
13|
14
14|
15
15|### 授权验证
16
16|- 在创建知识库，选择数据源时，点击 ** 同步自 Notion 内容— 去绑定，根据提示完成授权验证。**
17
17|- 你也可以：进入 ** 设置 — 数据来源 — 添加数据源 ** 中点击 Notion 来源 ** 绑定 **，完成授权验证。
18
18|
19
19|
20
20|### 导入 Notion 数据完成验证授权后，进入创建知识库页面，点击 ** 同步自 Notion 内容 **，选择需要的授权页面进行导入。
21
21|
22
22|
23
23|### 进行分段和清洗接下来，选择知识库的 ** 分段设置 ** 和 ** 索引方式 **，** 保存并处理 **。等待 Dify 自动处理数据。Dify 不仅可以导入 Notion 的普通类型页面，同时也支持导入并汇总保存 database 类型下的页面属性。
24
24|
25
25|*** 请注意：暂不支持导入图片和文件，表格类数据会被转换为文本展示。***
26
26|
27
27|
28
28|### 同步 Notion 数据如果你的 Notion 内容有更新，可以在知识库的 ** 文档列表页 ** 中点击对应内容页的 ** 同步 ** 按钮进行数据同步。同步文档涉及嵌入过程，因此将消耗嵌入模型的 Tokens。
29
29|
30
30|
31
31|### 社区版 Notion 的集成配置方法 Notion 分为 ** 内部集成 **（internal integration）和 ** 外部集成 **（public integration）两种方式，两种集成方式的具体区别请参阅[Notion 官方文档](https://developers.notion.com/guides/get-started/authorization)。
32
32|
33
33|
34
34|### 1、** 使用 internal 集成方式 ** 首先，在集成的设置页面中[创建集成](https://www.notion.so/my-integrations)。默认情况下，所有集成都以内部集成开始；内部集成将与你选择的工作区相关联，因此你需要是工作区所有者才能创建集成。
35
35|
36
36|具体操作步骤：
37
37|
38
38|点击“**New integration**”按钮，类型默认是 **Internal**（不可修改），选择关联的空间，输入集成名称并上传 logo 后，点击“Submit”，集成创建成功。
39
39|
40
40|
41
41|创建集成后，你可以根据需要在 Capabilities 选项卡下更新其设置，并在 Secrets 下点击 “Show” 按钮然后复制 Secrets。
42
42|
43
43|
44
44|复制后回到 Dify 源代码下，在 **.env** 文件里配置相关环境变量，环境变量如下：
45
45|
46
46|
47
47|```
48
48|`NOTION_INTEGRATION_TYPE = internal or NOTION_INTEGRATION_TYPE = public
49
49|NOTION_INTERNAL_SECRET=you-internal-secret
50
50|`
51
51|```
52
52|
53
53|### 2、** 使用 Public 集成方式 **** 需要将 internal 集成升级为 public 集成 **，导航到集成的 Distribution 页面，然后切换开关以公开集成。将开关切换到公共设置，你需要在下面的 Organization Information 表单中填写其他信息，包括你的公司名称、网站和重定向 URL 等信息，然后点击“Submit”按钮。
54
54|
55
55|
56
56|在集成的设置页面中成功公开集成后，你将能够在密钥选项卡中访问集成的密钥：
57
57|
58
58|
59
59|回到 Dify 源代码下，在 **.env** 文件里配置相关环境变量，环境变量如下：
60
60|
61
61|
62
62|```
63
63|`NOTION_INTEGRATION_TYPE=public
64
64|NOTION_CLIENT_SECRET=you-client-secret
65
65|NOTION_CLIENT_ID=you-client-id
66
66|`
67
67|```
68
68|配置完成后，即可在知识库中操作 Notion 的数据导入及同步功能。
69
69|

1
 1|# 从网页导入数据
2
 2|
3
 3|> 原文：[从网页导入数据](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website)。
11
11|
12
12|知识库支持通过第三方工具如[Jina Reader](https://jina.ai/reader),[Firecrawl](https://www.firecrawl.dev/) 抓取公开网页中的内容，解析为 Markdown 内容并导入至知识库。
13
13|
14
14|
15
15|> 💡 Jina Reader 和 Firecrawl 均是开源的网页解析工具，能将网页将其转换为干净并且方便 LLM 识别的 Markdown 格式文本，同时提供了易于使用的 API 服务。
16
16|
17
17|
18
18|下文将分别介绍 Firecrawl 和 Jina Reader 的使用方法。
19
19|
20
20|
21
21|## Firecrawl
22
22|### 配置 Firecrawl 凭据点击右上角头像，然后前往 **DataSource** 页面，点击 Firecrawl 右侧的 Configure 按钮。
23
23|
24
24|
25
25|登录[Firecrawl 官网](https://www.firecrawl.dev/) 完成注册，获取 API Key 后按照页面提示填入并点击保存。
26
26|
27
27|
28
28|### 使用 Firecrawl 抓取网页内容在知识库创建页选择 **Sync from website**，provider 选中 Firecrawl，填入需要抓取的目标 URL。
29
29|
30
30|设置中的配置项包括：是否抓取子页面、抓取页面数量上限、页面抓取深度、排除页面、仅抓取页面、提取内容。完成配置后点击 **Run**，预览将要被抓取的目标页面链接。
31
31|
32
32|
33
33|导入网页解析的文本后存储至知识库的文档中，查看导入结果。点击 **Add URL** 可以继续导入新的网页。抓取完成后，网页中的内容将会被收录至知识库内。
34
34|
35
35|
36
36|## Jina Reader
37
37|### 配置 Jina Reader 凭据点击右上角头像，然后前往 **DataSource** 页面，点击 Jina Reader 右侧的 Configure 按钮。
38
38|
39
39|
40
40|登录[Jina Reader 官网](https://jina.ai/reader) 完成注册，获取 API Key 后并按照页面提示填入并保存。
41
41|
42
42|
43
43|### 使用 Jina Reader 抓取网页内容在知识库创建页选择 **Sync from website**，provider 选中 Jina Reader，填写需要抓取的目标 URL。
44
44|
45
45|
46
46|设置中的配置项包括：是否抓取子页面、抓取页面数量上限、是否使用 sitemap 抓取。完成配置后点击 **Run** 按钮，预览将要被抓取的页面链接。
47
47|
48
48|
49
49|导入网页解析的文本后存储至知识库的文档中，查看导入结果。如需继续添加网页，轻点右侧 **Add URL** 按钮继续导入新的网页。
50
50|
51
51|
52
52|抓取完成后，网页中的内容将会被收录至知识库内。
53
53|

1
 1|# 快速创建知识库
2
 2|
3
 3|> 原文：[快速创建知识库](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/introduction)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/introduction)。
11
11|
12
12|快速创建并配置知识库的步骤如下：
13
13|
14
14|
15
15|- 点击 ** 知识库 **>** 创建知识库 **。然后，[上传本地文件](/zh/use-dify/knowledge/create-knowledge/import-text-data/readme)、[从 Notion 导入数据](/zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion)、[从网页导入数据](/zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website)，或创建一个空的知识库。
16
16|
17
17|
18
18|- [指定分段设置](/zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text)。该阶段是内容的预处理与数据结构化过程，长文本将会被划分为多个内容分段。你可以在此环节预览文本的分段效果。
19
19|
20
20|
21
21|- [指定索引方式和检索设置](/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods)。知识库在接收到用户查询问题后，按照预设的检索方式在已有的文档内查找相关内容，提取出高度相关的信息片段供语言模型生成高质量答案。
22
22|
23
23|
24
24|- 等待数据处理完成，完成知识库的创建。
25
25|

1
 1|# 指定索引方式与检索设置
2
 2|
3
 3|> 原文：[指定索引方式与检索设置](https://docs.dify.ai/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/create-knowledge/setting-indexing-methods)。
11
11|
12
12|选定内容的分段模式后，接下来设定对于结构化内容的 ** 索引方式 **。
13
13|
14
14|
15
15|## 选择索引方式正如搜索引擎通过高效的索引算法匹配与用户问题最相关的网页内容，索引方式是否合理将直接影响 LLM 对知识库内容的检索效率以及回答的准确性。
16
16|
17
17|提供 ** 高质量 ** 与 ** 经济 ** 两种索引方式，其中分别提供不同的检索设置选项。
18
18|
19
19|
20
20|- 高质量
21
21|- 经济:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0" data-component-part="tab-content">
22
22|> ⚠️ 一旦以高质量型索引方式创建知识库，后续无法切换为经济型索引。
23
23|
24
24|
25
25|高质量索引方式使用嵌入模型将内容分段转化为数字向量，这一过程称为嵌入或向量化。
26
26|
27
27|这些向量可理解为多维空间中的坐标点——两个点越接近，它们的语义越相似。这使得系统能够基于语义相似度（而不仅仅是关键词匹配）找到相关信息。
28
28|
29
29|
30
30|> 💡 若要启用跨模态检索——即基于语义相关性同时检索文本和图片——需选择多模态嵌入模型（带有 **Vision** 图标）。从文档中提取的图片将被嵌入并索引以供检索。
31
31|
32
32|使用此类嵌入模型的知识库，其卡片上标有 **Multimodal**。
33
33|
34
34|
35
35|高质量索引方式支持三种检索策略：向量检索、全文检索或混合检索。详见[指定检索设置](#%E6%8C%87%E5%AE%9A%E6%A3%80%E7%B4%A2%E8%AE%BE%E7%BD%AE)。
36
36|
37
37|
38
38|### Q&A 模式
39
39|> 💡 Q&A 模式仅适用于自托管部署。
40
40|
41
41|
42
42|开启该模式后，系统将对已上传的文本进行分段。总结内容后为每个分段自动生成 Q&A 匹配对。
43
43|
44
44|与常见的 「Q to P」（用户问题匹配文本段落）策略不同，Q&A 模式采用 「Q to Q」（问题匹配问题）策略。
45
45|
46
46|这种方法特别有效，因为常见问题文档中的文本 ** 通常是具备完整语法结构的自然语言 **。
47
47|
48
48|**Q to Q** 策略使问题和答案的匹配更加清晰，并能更好地支持高频或高相似度问题的场景。
49
49|
50
50|
51
51|当用户提问时，系统会找出与之最相似的问题，然后返回对应的分段作为答案。这种方式更加精确，因为它直接针对用户问题进行匹配，可以更准确地帮助用户检索真正需要的信息。
52
52|
53
53|
54
54|:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0 hidden" data-component-part="tab-content"> 在经济模式下，每个区块内使用 10 个关键词进行检索，降低了准确度但无需消耗 Token。对于检索到的区块，仅提供倒排索引方式选择最相关的区块。
55
55|
56
56|如果经济型索引方式的效果不符合预期，可以在知识库设置页中升级为高质量索引方式。
57
57|
58
58|
59
59|## 指定检索设置知识库在接收到用户查询问题后，按照预设的检索方式在已有的文档内查找相关内容，提取出高度相关的信息片段。这些片段为 LLM 提供必要的上下文，最终影响其回答的准确性和可信度。
60
60|
61
61|常见的检索方式包括：
62
62|
63
63|
64
64|- 基于向量相似度的语义检索——将文本块和查询转化为向量，通过相似度评分进行匹配。
65
65|- 使用倒排索引的关键词匹配（一种标准的搜索引擎技术）。Dify 的知识库支持这两种检索方式。具体可用的检索选项取决于所选的索引方式。
66
66|
67
67|
68
68|- 高质量
69
69|- 经济:first-child:not(p)]:mt-0 [&>:first-child:not(p)_img]:mt-0 [&>:first-child[data-table-wrapper]]:!pt-0" data-component-part="tab-content">** 高质量 **
70
70|
71
71|在 ** 高质量 ** 索引方式下，Dify 提供三种检索设置：** 向量检索、全文检索和混合检索 **。
72
72|
73
73|
74
74|** 向量检索 **
75
75|
76
76|** 定义 **： 向量化用户输入的问题并生成查询向量，然后将其与知识库中对应的文本向量进行比较，找到最相邻的分段。
77
77|
78
78|
79
79|** 向量检索设置 **：
80
80|
81
81|**Rerank 模型 **： 默认关闭。开启后将使用第三方 Rerank 模型对向量检索返回的文本分段进行重新排序，以优化结果。这有助于 LLM 获取更精确的信息并提升输出质量。开启该选项前，需前往 ** 设置 **→** 模型供应商 **，提前配置 Rerank 模型的 API 密钥。
82
82|
83
83|
84
84|> ⚠️ 若选择的嵌入模型为多模态，需同样选择多模态 Rerank 模型（带有 **Vision** 图标）。否则，检索到的图片将在重排序和检索结果中被排除。
85
85|
86
86|
87
87|开启该功能后，将消耗 Rerank 模型的 Token。详情请参考对应模型的价格说明。
88
88|
89
89|**TopK**： 用于确定检索与用户问题相似度最高的文本分段数量。系统同时会根据选用模型上下文窗口大小动态调整分段数量。默认值为 **3**，数值越高，预期被召回的文本分段数量越多。
90
90|
91
91|**Score 阈值 **： 用于设置文本分段被检索所需的最低相似度分数。只有超过该分数的分段才会被检索。默认值为 **0.5**。阈值越高，对相似度要求越高，因此被检索的分段数量越少。
92
92|
93
93|TopK 和 Score 设置仅在 Rerank 阶段生效。因此，要应用这些设置中的任何一项，需要添加并启用 Rerank 模型。
94
94|
95
95|** 全文检索 **
96
96|
97
97|** 定义 **： 索引文档中的所有词汇，允许用户查询任意词汇并返回包含这些词汇的文本片段。
98
98|
99
99|

1
 1|# 外部知识库 API
2
 2|
3
 3|> 原文：[外部知识库 API](https://docs.dify.ai/zh/use-dify/knowledge/external-knowledge-api)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/external-knowledge-api)。
11
11|
12
12|本页定义了外部知识服务必须实现的 API 协议，以便 Dify 从中检索内容。API 准备就绪后，详见[连接外部知识库](/zh/use-dify/knowledge/connect-external-knowledge-base) 在 Dify 中完成注册。
13
13|
14
14|
15
15|## 认证 Dify 在每个请求中将你配置的 API Key 作为 Bearer 令牌发送：
16
16|
17
17|
18
18|```
19
19|`Authorization: Bearer ***
20
20|`
21
21|```
22
22|认证逻辑由你自行定义。Dify 仅传递密钥，不会对其进行验证。
23
23|
24
24|
25
25|## 请求
26
26|```
27
27|`POST {your-endpoint}/retrieval
28
28|Content-Type: application/json
29
29|Authorization: Bearer ***
30
30|`
31
31|```
32
32|Dify 在你配置的端点 URL 后追加`/retrieval`。如果注册的地址为`https://your-service.com`，Dify 将请求发送至`https://your-service.com/retrieval`。
33
33|
34
34|
35
35|### 请求体属性必填类型说明`knowledge_id`是 string 外部系统中知识源的标识符，即连接时填写的 ** 外部知识库 ID** 字段的值，用于将查询路由到正确的知识源。`query`是 string 用户的搜索查询。`retrieval_setting`是 object 检索参数。详见[下文](#retrieval_setting)。`metadata_condition`否 object 元数据筛选条件。详见[下文](#metadata_condition)。
36
36|#### `retrieval_setting`属性必填类型说明`top_k`是 int 返回结果的最大数量。`score_threshold`是 float 最低相似度分数（0-1）。在 Dify 中禁用分数阈值时，此值为`0.0`。
37
37|#### `metadata_condition`
38
38|> 💡 Dify 将元数据条件传递给你的 API，但目前未提供供用户配置的界面。此参数仅用于程序化调用。
39
39|
40
40|
41
41|属性必填类型说明`logical_operator`否 string`and`或`or`。默认值：`and`。`conditions`是 array[object]筛选条件列表。`conditions`中每个对象的结构：
42
42|
43
43|属性必填类型说明`name`是 string 要筛选的元数据字段名称。`comparison_operator`是 string 比较运算符。支持的值见下文。`value`否 string、number 或 array[string]比较值。使用`empty`或`not empty`时可省略。支持的比较运算符
44
44|
45
45|运算符说明`contains`包含某个值`not contains`不包含某个值`start with`以某个值开头`end with`以某个值结尾`is`等于某个值`is not`不等于某个值`in`匹配列表中的任意值`not in`不匹配列表中的任意值`empty`为空`not empty`不为空`=`等于（数值）`≠`不等于（数值）`>`大于`<`小于`≥`大于或等于`≤`小于或等于`before`在某个日期之前`after`在某个日期之后
46
46|### 请求示例
47
47|```
48
48|`{
49
49|"knowledge_id":"your-knowledge-id",
50
50|"query":"Dify 是什么？",
51
51|"retrieval_setting": {
52
52|"top_k":3,
53
53|"score_threshold":0.5
54
54|}
55
55|}
56
56|`
57
57|```
58
58|
59
59|## 响应返回 HTTP 200，响应体为包含`records`数组的 JSON。如果没有匹配结果，返回空数组：`{"records": []}`。
60
60|
61
61|
62
62|### `records`属性类型说明`content`string 检索到的文本分段。Dify 将其作为传递给 LLM 的上下文。`score`float 相似度分数（0-1）。用于分数阈值过滤和结果排序。`title`string 源文档标题。`metadata`object 由 Dify 保留的任意键值对。Dify 不会拒绝缺少字段的记录，但缺少`content`或`score`将导致结果不完整或无法排序。
63
63|
64
64|
65
65|> 💡 记录中的`metadata`必须是对象（`{}`），不能为`null`。`null`值将导致 Dify 检索流程出错。
66
66|
67
67|
68
68|### 响应示例
69
69|```
70
70|`{
71
71|"records": [
72
72|{
73
73|"content":"这是外部知识库的文档。",
74
74|"score":0.98,
75
75|"title":"knowledge.txt",
76
76|"metadata": {
77
77|"path":"s3://dify/knowledge.txt",
78
78|"description":"dify 知识文档"
79
79|}
80
80|},
81
81|{
82
82|"content":"GenAI 应用的创新引擎",
83
83|"score":0.66,
84
84|"title":"introduce.txt",
85
85|"metadata": {}
86
86|}
87
87|]
88
88|}
89
89|`
90
90|```
91
91|
92
92|## 错误处理 Dify 检查响应的 HTTP 状态码。非 200 状态码将触发错误并展示给用户。
93
93|
94
94|可选择在 JSON 中返回结构化的错误信息：
95
95|
96
96|属性类型说明`error_code`int 自定义的应用级错误码。`error_msg`string 可读的错误描述。以下是建议的错误码，仅为约定，Dify 不强制要求：
97
97|
98
98|错误码建议用途 1001 无效的 Authorization 请求头格式 1002 认证失败 2001 知识库不存在
99
99|### 错误响应示例

1
 1|# 在应用内集成知识库
2
 2|
3
 3|> 原文：[在应用内集成知识库](https://docs.dify.ai/zh/use-dify/knowledge/integrate-knowledge-within-application)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/integrate-knowledge-within-application)。
11
11|
12
12|知识库可以作为外部知识提供给大语言模型用于精确回复用户问题，你可以在 Dify 的[所有应用类型](/zh/use-dify/getting-started/key-concepts#dify-%E5%BA%94%E7%94%A8) 内关联已创建的知识库。
13
13|
14
14|以聊天助手为例，使用流程如下：
15
15|
16
16|
17
17|- 进入 ** 工作室 — 创建应用 —创建聊天助手 **
18
18|- 进入 ** 上下文设置 ** 点击 ** 添加 ** 选择已创建的知识库
19
19|- 在 ** 上下文设置 — 参数设置 ** 内配置 ** 召回策略 **
20
20|- 在 ** 元数据筛选 ** 板块中配置元数据的筛选条件，使用元数据功能筛选知识库内的文档
21
21|- 在 ** 添加功能 ** 内打开 ** 引用和归属 **
22
22|- 在 ** 调试与预览 ** 内输入与知识库相关的用户问题进行调试
23
23|- 调试完成之后 ** 保存并发布 ** 为一个 AI 知识库问答类应用
24
24|### 关联知识库并指定召回模式如果当前应用的上下文涉及多个知识库，需要设置召回模式以使得检索的内容更加精确。进入 ** 上下文 — 参数设置 — 召回设置 **。
25
25|
26
26|
27
27|#### 召回设置检索器会在所有与应用关联的知识库中去检索与用户问题相关的文本内容，并将多路召回的相关文档结果合并，以下是召回策略的技术流程图：
28
28|
29
29|
30
30|根据用户意图同时检索所有添加至 **“上下文”** 的知识库，在多个知识库内查询相关文本片段，选择所有和用户问题相匹配的内容，最后通过 Rerank 策略找到最适合的内容并回答用户。该方法的检索原理更为科学。
31
31|
32
32|
33
33|举例：A 应用的上下文关联了 K1、K2、K3 三个知识库，当用户输入问题后，将在三个知识库内检索并汇总多条内容。为确保能找到最匹配的内容，需要通过 Rerank 策略确定与用户问题最相关的内容，确保结果更加精准与可信。
34
34|
35
35|在实际问答场景中，每个知识库的内容来源和检索方式可能都有所差异。针对检索返回的多条混合内容，Rerank 策略是一个更加科学的内容排序机制。它可以帮助确认候选内容列表与用户问题的匹配度，改进多个知识间排序的结果以找到最匹配的内容，提高回答质量和用户体验。
36
36|
37
37|考虑到 Rerank 的使用成本和业务需求，多路召回模式提供了以下两种 Rerank 设置：
38
38|
39
39|** 权重设置 **
40
40|
41
41|该设置无需配置外部 Rerank 模型，重排序内容 ** 无需额外花费 **。可以通过调整语义或关键词的权重比例条，选择最适合的内容匹配策略。
42
42|
43
43|
44
44|- ** 语义值为 1**
45
45|
46
46|仅启用语义检索模式。借助 Embedding 模型，即便知识库中没有出现查询中的确切词汇，也能通过计算向量距离的方式提高搜索的深度，返回正确内容。此外，当需要处理多语言内容时，语义检索能够捕捉不同语言之间的意义转换，提供更加准确的跨语言搜索结果。
47
47|
48
48|语义检索指的是比对用户问题与知识库内容中的向量距离。距离越近，匹配的概率越大。参考阅读：[《Dify：Embedding 技术与 Dify 数据集设计 / 规划》](https://mp.weixin.qq.com/s/vmY_CUmETo2IpEBf1nEGLQ)。
49
49|
50
50|
51
51|- ** 关键词值为 1**
52
52|
53
53|仅启用关键词检索模式。通过用户输入的信息文本在知识库全文匹配，适用于用户知道确切的信息或术语的场景。该方法所消耗的计算资源较低，适合在大量文档的知识库内快速检索。
54
54|
55
55|
56
56|- ** 自定义关键词和语义权重 **
57
57|
58
58|除了仅启用语义检索或关键词检索模式，我们还提供了灵活的自定义权重设置。你可以通过不断调试二者的权重，找到符合业务场景的最佳权重比例。
59
59|
60
60|**Rerank 模型 **
61
61|
62
62|Rerank 模型是一种外部评分系统，它会计算用户问题与给定的每个候选文档之间的相似度分数，从而改进语义排序的结果，并返回按相似度分数从高到低排序的文档列表。
63
63|
64
64|虽然此方法会产生一定的额外花费，但是更加擅长处理知识库内容来源复杂的情况，例如混合了语义查询和关键词匹配的内容，或返回内容存在多语言的情况。
65
65|
66
66|Dify 目前支持多个 Rerank 模型，进入 “模型供应商” 页填入 Rerank 模型（例如 Cohere、Jina AI 等模型）的 API Key。
67
67|
68
68|
69
69|** 可调参数 **
70
70|
71
71|
72
72|- **TopK**
73
73|
74
74|用于筛选与用户问题相似度最高的文本片段。系统同时会根据选用模型上下文窗口大小，动态调整分段数量。数值越高，预期被召回的文本分段数量越多。
75
75|
76
76|
77
77|- **Score 阈值 **
78
78|
79
79|用于设置文本片段筛选的相似度阈值。向量检索的相似度分数需要超过设置的分数后才会被召回，数值越高，预期被召回的文本数量越少。
80
80|
81
81|
82
82|### 使用元数据筛选知识
83
83|#### 聊天流 / 工作流在 ** 聊天流 / 工作流 ** 的 ** 知识检索 ** 节点中，你可以使用 ** 元数据筛选 ** 功能精确检索文档。该功能有助于你根据文档的元数据字段（如标签、类别或访问权限）优化检索结果。
84
84|
85
85|配置步骤
86
86|- 选择筛选模式
87
87|
88
88|
89
89|- ** 禁用模式 **（默认）：禁用 ** 元数据筛选 ** 功能，不配置任何筛选条件。
90
90|
91
91|
92
92|- ** 自动模式 **：系统会根据传输给该 ** 知识检索 ** 节点的 ** 查询变量 ** 自动配置筛选条件，适用于简单的筛选需求。
93
93|
94
94|启用自动模式后，你依然需要在 ** 模型 ** 栏中选择合适的大模型以执行文档检索任务。
95
95|
96
96|
97
97|- ** 手动模式 **：用户可以手动配置筛选条件，自由设置筛选规则，适用于复杂的筛选需求。
98
98|
99
99|

1
 1|# 数据源授权
2
 2|
3
 3|> 原文：[数据源授权](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/authorize-data-source)。
11
11|
12
12|Dify 支持多种外部数据源的连接，为了确保数据安全和访问控制，不同的数据源需要进行相应的授权配置。根据数据源的特性，Dify 提供两种主要的授权方式：**API Key** 和 **OAuth**，以确保你能够安全地访问和导入所需的数据。
13
13|
14
14|
15
15|## 数据源授权界面入口在 Dify 中，你可以通过以下两种方式进入数据源授权配置界面：
16
16|
17
17|
18
18|### 方式一：通过知识流水线编排界面进入知识流水线编排界面，添加需要的数据源。选中数据源节点，在右侧面板中，点击 ** 绑定 **。
19
19|
20
20|
21
21|### 方式二：设置界面点击右上角头像，选择 ** 设置 **，点击 ** 数据来源 **。进入数据来源页面后，选择需要授权的数据源，点击 ** 配置 **。
22
22|
23
23|
24
24|## 支持数据源及授权方式数据源 API KeyOAuthNotion✅✅Jina Reader✅Firecrawl✅Google Drive✅Dropbox✅✅OneDrive✅
25
25|## 授权方式和流程
26
26|### API Key 授权 API Key 授权是一种基于密钥的身份验证方式，适用于企业级服务和开发者工具。用户需要在对应的服务提供商处生成 API Key，然后在 Dify 中进行配置。
27
27|
28
28|
29
29|#### 授权流程
30
30|- 在数据源配置界面，选择对应的数据源，点击右侧的 ** 配置 **，选择 ** 添加 API Key**。
31
31|
32
32|
33
33|- 在弹出的配置面板中，填写对应信息。完成后，点击 ** 保存 ** 完成授权。
34
34|
35
35|API 密钥将被安全加密储存，配置成功后会显示 **Connected** 状态，你可以在知识流水线中使用该数据源。
36
36|
37
37|
38
38|### OAuth 授权 OAuth 是一种开放标准的授权协议，允许用户在不暴露密码的情况下，授权第三方应用访问其在特定服务提供商上的资源。Dify 提供两种 OAuth 授权配置方式：默认配置和自定义配置。
39
39|
40
40|
41
41|#### 授权流程
42
42|- 在数据源配置界面，选择对应的数据源，点击右侧的 ** 配置 **，选择 ** 添加 OAuth**。
43
43|
44
44|
45
45|- 在授权页面中查看并确认权限范围后，点击 ** 允许访问 **。
46
46|
47
47|
48
48|#### OAuth 客户端设置 Dify 提供默认和自定义两种 OAuth 客户端配置方式。
49
49|
50
50|
51
51|- ** 默认客户端 ** 仅 SaaS 版本支持默认客户端，你可以使用 Dify 官方预配置并维护的 OAuth 客户端参数，在 SaaS 版本一键添加 OAuth 凭据，无需进行额外的配置。
52
52|
53
53|
54
54|- ** 自定义客户端 **Dify 所有版本均支持自定义客户端。对于 SaaS 版本中尚未提供的默认配置数据源，你需要前往第三方平台自行注册并获取 OAuth 客户端参数。
55
55|
56
56|** 授权流程 **
57
57|
58
58|
59
59|- 在数据源配置界面，选择对应的数据源，点击右侧的 ** 配置 **，选择 ** 添加 OAuth** 右侧的 ** 设置图标 **，进入 OAuth 客户端设置。
60
60|
61
61|
62
62|- 点击 ** 自定义 **，输入 **Client ID** 和 **Client Secret**。点击 ** 保存并授权 ** 完成 OAuth 授权流程。
63
63|

1
 1|# 步骤一：创建知识流水线
2
 2|
3
 3|> 原文：[步骤一：创建知识流水线](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline)。
11
11|
12
12|点击顶部的 ** 知识库 **，在左侧点击 ** 通过知识流水线创建知识库 **，你可以通过以下 3 种方式来创建知识流水线。
13
13|
14
14|
15
15|### 方式一：从零开始构建点击 ** 空白知识流水线 ** 即可从零开始构建自定义知识流水线。
16
16|如果你需要根据数据特点和业务需求自定义处理策略，建议选择从空白知识流水线开始。
17
17|
18
18|
19
19|### 方式二：通过模版创建 Dify 提供了两种模版方案：** 内置流水线 **（Built-in) 和 ** 自定义 **（Customized)。两种模版的卡片信息都包含了知识库名称、简介描述和标签（包含分段模式）。
20
20|
21
21|
22
22|#### 内置流水线（Built-in Pipeline) 内置流水线为预置的知识流水线模版，针对常见的文档数据结构进行优化，你可以根据不同的文档类型和使用场景选择适合的处理方式。点击 ** 选择 ** 即可开始使用。
23
23|
24
24|** 模版类型 **
25
25|
26
26|模版名称分段结构索引方式检索设置说明通用模式（General Mode）通用模式经济倒排索引将文档内容分割成较小的段落块（通用块），直接用于匹配用户查询和检索。父子模式（Parent-child Structure) 父子模式高质量混合检索采用了高级分块策略，将文档文本分成较大的”父块”和较小的”子块”。其中，“父块”包含了”子块”。这样既保证了检索的精确性，又维持了上下文的完整性。简单问答（Simple Q&A) 问答模式高质量向量搜索将表格数据转化为一问一答的形式，通过问题匹配来快速找到对应的答案信息。适用于结构化表格数据。复杂 PDF （含图片和表格）（Complex PDF with Images & Tables）父子模式高质量混合检索 - 加权评分提取 PDF 文件内的图像和表格内容。LLM 上下文增强（Contextual Enriching Using LLM) 父子模式高质量混合检索 - 加权评分将文档内的图片和表格提取出来，使用大型语言模型自动生成描述性注释，实现上下文的智能增强。Markdown 转换（Convert to Markdown) 父子模式高质量混合检索 - 加权评分专为 DOCX、XLSX 和 PPTX 等 Office 原生文件格式设计，将其转换为 Markdown 格式以便更好地进行信息处理。⚠️ 注意：不推荐使用 PDF 文件。LLM 生成问答（LLM Generated Q&A) 问答模式高质量向量搜索 - 加权评分使用大型语言模型自动生成结构化的问答对，通过问题匹配机制找到相关的答案信息。点击模版卡片上的详情按钮，即可在弹窗中预览选中的流水线的编排结构、流水线简介和分段模式。点击使用此知识流水线模版进行编排。
27
27|
28
28|
29
29|#### 自定义（Customized）自定义模版为用户创建和发布为知识流水线的方案，你可以选择使用该模版、导出 DSL，或点击详情进行快速预览。
30
30|
31
31|点击模版卡片上的选择按钮，即可从该自定义模版开始创建知识库。你也可以在预览该流水线模版时，点击右侧的使用此知识流水线按钮开始创建。点击 … 可以编辑流水线信息、导出知识流水线或者删除模版。
32
32|
33
33|
34
34|### 方式三：导入知识流水线在完成知识流水线的编排后，你可以保存和导出知识流水线，并分享给其他人。知识库使用者可以导入知识流水线，快速复用已构建的知识流水线，并在此基础上针对不同情景或需求进行修改。与工作流 DSL 类似，知识流水线基于相同的 YAML 格式标准，用于定义知识库内的处理流程和配置。
35
35|
36
36|知识流水线包含以下内容：
37
37|
38
38|名称包含数据源文件上传、网站、在线文档和在线网盘数据处理流程文档提取、内容分块和清洗策略知识库储存配置索引方式、检索设置和存储参数节点连接节点间的连接和处理顺序用户输入表单自定义的参数输入字段（如有配置）
39
39|

1
 1|# 步骤二：编排知识流水线
2
 2|
3
 3|> 原文：[步骤二：编排知识流水线](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration)。
11
11|
12
12|想象一下你正在搭建一条生产流水线，每个站点执行特定任务，你将不同它们连接起来将每个零部件组装最终成品。知识流水线编排与此类似，你组合不同节点，将原始文档数据通过每个节点逐步转化为可搜索的知识库。在 Dify 里，你通过可视化的方式，拖放和连接不同节点，对文档数据进行提取和分块处理，并配置索引方式和检索策略。
13
13|
14
14|在这个章节，你将了解知识流水线的过程，理解不同节点的含义和配置，如何自定义构建数据处理流程，从而高效地管理和优化知识库。
15
15|
16
16|
17
17|### 界面状态进入知识流水线编排界面时，你会看到：
18
18|
19
19|
20
20|- ** 标签页状态 **：Documents（文档）、Retrieval Test（召回测试）和 Settings（设置）标签页将显示为置灰且不可用状态
21
21|- ** 必要步骤 **：你必须完成知识流水线的配置、调试和发布后，才能上传文件或使用其他功能如果你选择了 ** 空白知识流水线 **，你将看到仅包含知识库节点的画布。你可以跟随该节点旁的指引，逐步完成流水线创建。
22
22|
23
23|如果选择 ** 特定的流水线模版 **，编排界面将直接显示该流水线模版。
24
24|
25
25|
26
26|## 知识流水线处理流程在开始之前，我们先拆解知识流水线的处理流程，你可以更好地理解数据是如何一步步转化为可用的知识库。
27
27|
28
28|
29
29|> 💡 ** 数据源配置 → 数据处理节点（文档提取器 + 分块器）→ 知识库节点（分块结构 + 索引配置） → 配置用户输入表单 → 测试发布 **
30
30|
31
31|
32
32|- ** 数据源配置 **：来自各种数据源的原始内容（本地文件、Notion、网页等）
33
33|- ** 数据处理节点配置 **：处理和转换数据内容
34
34|- 提取器 (Extractor) → 解析和结构化原始文档内容
35
35|- 分块器 (Chunker) → 将结构化内容分割为适合处理的片段
36
36|- ** 知识库节点配置 **：设置知识库的分段结构和检索策略
37
37|- ** 用户输入表单配置 **：定义流水线使用者需要输入的参数
38
38|- ** 测试与发布 **：验证并正式启用知识库
39
39|## 步骤一：数据源配置在一个知识库里，你可以选择单一或多个数据源。目前，Dify 支持 4 种数据源：** 文件上传、在线网盘、在线文档和网页爬虫 **。
40
40|
41
41|你也可以前往[Dify Marketplace](https://marketplace.dify.ai)，获得更多数据源。
42
42|
43
43|
44
44|### 文件上传用户可以直接选择本地文件进行上传，以下是配置选项和限制。
45
45|
46
46|** 配置选择 **
47
47|
48
48|配置项说明文件格式支持 pdf, xlxs, docs 等，用户可自定义选择上传方式通过拖拽或选择文件或文件夹上传本地文件，支持批量上传 ** 限制 **
49
49|
50
50|限制项说明文件数量每次最多上传 50 个文件文件大小每个文件大小不超过 15MB 储存限制不同 SaaS 版本的订阅计划对文档上传总数和向量存储空间有所限制 ** 输出变量 **
51
51|
52
52|输出变量变量格式`{x} Document`单个文档
53
53|### 在线文档
54
54|#### Notion 将知识库连接 Notion 工作区，可直接导入 Notion 页面和数据库内容，支持后续的数据自动同步。
55
55|
56
56|** 配置选项说明 **
57
57|
58
58|配置项选项输出变量说明 Extractor 开启`{x} Content`输出结构化处理的页面信息关闭`{x} Document`输出页面的原始文本信息
59
59|### 网页爬虫将网页内容转化为大型语言模型容易识别的格式，知识库支持 Jina Reader 和 Firecrawl，提供灵活的网页解析能力。
60
60|
61
61|
62
62|#### Jina Reader 开源网页解析工具，提供简洁易用的 API 服务，适合快速抓取和处理网页内容。
63
63|
64
64|** 参数配置和说明 **
65
65|
66
66|参数类型说明 URL 必填目标网页地址爬取子页面 (Crawl sub-page) 可选是否抓取链接页面使用站点地图 (Use sitemap) 可选利用网站地图进行爬取爬取页数限制 (Limit) 必填设置最大抓取页面数量启用内容提取器 (Enable Extractor) 可选选择数据提取方式
67
67|#### Firecrawl 开源网页解析工具，提供更精细的爬取控制选项和 API 服务，支持复杂网站结构的深度爬取，适合需要批量处理和精确控制的场景。
68
68|
69
69|** 参数配置和说明 **
70
70|
71
71|参数类型说明 URL 必填目标网页地址爬取页数限制 (Limit) 必填设置最大抓取页面数量爬取子页面 (Crawl sub-page) 可选是否抓取链接页面最大爬取深度 (Max depth) 可选控制爬取层级深度排除路径 (Exclude paths) 可选设置不爬取的页面路径仅包含路径 (Include only paths) 可选限制只爬取指定路径启用内容提取器 (Extractor) 可选选择数据处理方式只提取主要内容可选过滤页面辅助信息
72
72|### 在线网盘连接你的在线云储存服务（例如 Google Drive、Dropbox、OneDrive），Dify 将自动检索云储存中的文件，你可以勾选并导入相应文档进行下一步处理，无需手动下载文件再进行上传。
73
73|
74
74|
75
75|> 💡 关于第三方数据源授权，请前往[数据源授权](/zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source)。
76
76|
77
77|
78
78|## 步骤二：配置数据处理节点该阶段是内容的预处理与数据结构化过程，这一部分将会把数据源进行提取、分段并转换为适合知识库存储和检索的格式。你可以将这一步想象成备餐过程——处理原材料、进行清理、切分成小块，并整理好一切，以便在有人需要时能迅速”烹制”出这道”菜肴”。
79
79|
80
80|
81
81|> 💡 如需开发自定义数据处理插件，以提取可用于多模态向量化与检索的多模态数据，阅读[构建在知识流水线中处理多模态数据的工具插件](/zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool)。
82
82|
83
83|
84
84|### 文档处理由于知识库无法直接理解 PDF、Word 等各种文档格式，提取器负责将这些文档”解读”成系统可以处理的文本内容。它支持多种常见文件格式，确保你的文档内容能够被正确提取和处理，并转换为大型语言模型可以有效使用的格式。 你可以选择 Dify 文档提取器来处理文件，也可以根据你的需求从 Dify Marketplace 中选择更多工具。Marketplace 提供了如 Dify Extractor、Unstructured 等第三方工具。
85
85|
86
86|对于文档中的图片
87
87|
88
88|通过合适的文档处理工具，可将文档中的图片提取为对应分段的附件。被提取的图片可独立管理，并在检索时与分段一同返回。
89
89|
90
90|被提取图片的 URL 会保留在分段文本中，但你可以安全地删除这些 URL 以保持文本整洁——这不会影响已提取的图片。
91
91|
92
92|每个分段最多支持 10 个图片附件，超出的图片不会被提取。
93
93|
94
94|若使用的工具未提取到图片，Dify 会自动提取通过以下 Markdown 语法引用、URL 可访问且小于 2 MB 的 JPG、JPEG、PNG 和 GIF 图片：
95
95|
96
96|
97
97|- `![替换文本](image_url)`
98
98|- `![替换文本](image_url "标题")`
99
99|> 💡 对于自托管部署，可通过环境变量调整以下限制：

1
 1|# 步骤五：管理和使用知识库
2
 2|
3
 3|> 原文：[步骤五：管理和使用知识库](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base)。
11
11|
12
12|创建知识库后，你可以继续对其进行管理和优化，以确保它能为你的应用程序提供准确的的上下文信息。通过以下方式，你可以对知识库文件的进行更新、进行召回测试、修改流水线和修改知识库的属性等：
13
13|
14
14|
15
15|### 流水线浏览编排的流水线，并对节点和配置进行修改。
16
16|
17
17|
18
18|> 💡 你可前往[管理知识库文档](/zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents)，了解更多内容。
19
19|

1
 1|# 步骤三：发布知识流水线
2
 2|
3
 3|> 原文：[步骤三：发布知识流水线](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline)。
11
11|
12
12|完成知识流水线的编排和调试后，点击 ** 发布 ** 并在弹窗中点击 ** 确认 **，即成功发布知识流水线。
13
13|
14
14|
15
15|> 💡 ** 注意：知识流水线发布后，分段结构无法进行修改。** 由于分段结构会影响知识库的存储方式和检索召回策略，为确保数据一致性和用户体验，当前每个知识库仅支持 ** 一种分段结构 **。
16
16|
17
17|
18
18|成功发布后，你可以进行如下操作：
19
19|
20
20|** 添加文档（Go to add documents)** 点击此选项可以跳转到知识库选择数据源界面，你可以直接上传文档。
21
21|
22
22|** 访问 API（Access API Reference)** 前往 API 文档页面，你可以获取知识库的 API 调用方法和说明。
23
23|
24
24|** 发布为流水线（Publish as a Knowledge Pipeline)** 你可以点击发布为知识流水线将该流水线保存为可复用的模版，该模版将出现在自定义模版中。
25
25|
26
26|
27
27|> 💡 限制说明：Sandbox 不支持发布为知识流水线功能。如需保存并发布为知识流水线，请[升级](https://dify.ai/pricing) 至 Professional 或者 Team 方案。
28
28|

1
 1|# 通过知识流水线创建知识库
2
 2|
3
 3|> 原文：[通过知识流水线创建知识库](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/readme)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/readme)。
11
11|
12
12|知识流水线是构建处理文档流程的一种解决方案，你能够像编排工作流一样对不同节点进行可视化地组合和配置，并选择使用不同工具来优化数据处理过程。
13
13|
14
14|它主要包含四个环节，每个环节由不同的节点和工具组成，形成完整的数据处理链路：
15
15|
16
16|** 数据源 → 数据提取 → 数据处理 → 知识库存储 **
17
17|
18
18|每个步骤都有特定的用途：从各种来源收集内容，将其转换为可处理的文本，优化以便搜索，并以能够快速、准确检索的格式进行存储。
19
19|
20
20|此外，Dify 还提供不同使用场景的知识流水线模板，帮助提升数据索引和检索结果的准确度。本章节将帮助你了解知识流水线的创建方式、流程以及相应节点，让你能快速搭建和优化自己的知识库。
21
21|
22
22|1
23
23|## 步骤一：创建知识流水线从内置模板、空白知识库流水线开始创建，或导入现有流水线。
24
24|
25
25|2
26
26|## 步骤二： 编排知识流水线了解知识库流水线的工作原理，编排不同节点，构建你需要的的数据处理流程。
27
27|
28
28|3
29
29|## 步骤三：发布知识流水线测试配置无误后，发布流水线，准备进行文档处理。
30
30|
31
31|4
32
32|## 步骤四：上传文件添加文档，经过处理后构建成可搜索的知识库。
33
33|
34
34|5
35
35|## 步骤五：管理和使用知识库日常维护文档、测试检索效果、修改设置等。
36
36|

1
 1|# 步骤四：上传文件
2
 2|
3
 3|> 原文：[步骤四：上传文件](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-pipeline/upload-files)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-pipeline/upload-files)。
11
11|
12
12|完成知识流水线的编排、调试并发布成功后，你能通过以下两种方式上传文件：
13
13|
14
14|A. 在发布成功的弹窗哪点击前往文档。进入文档页面后，点击添加文件进行上传。
15
15|
16
16|B. 在发布的下拉菜单中，点击去添加文档。进入选择数据源页面，选择对应数据源开始上传文件。
17
17|
18
18|
19
19|### 上传流程
20
20|- ** 选择数据源 ** 从流水线配置的数据源类型中进行选择。目前，Dify 支持 4 种数据源 ** 文件上传（pdf, docx 等）、在线网盘（Google Drive, OneDrive 等）、在线文档（Notion) 和 网页爬虫（Jina Reader 和 Firecrawl）。** 请前往[Dify Marketplace](https://marketplace.dify.ai/) 获取更多数据源支持。
21
21|
22
22|
23
23|- ** 填写文件处理相关参数和变量 ** 如果你在知识流水线的编排过程中配置了用户输入字段，需要在这一步填写所需的参数和变量。完成填写后，点击 ** 预览分段 ** 可进行预览。点击保存并处理完成知识库创建，进入数据处理阶段。
24
24|
25
25|
26
26|> 💡 注意：分段结构与知识流水线内保持一致，不会因用户输入的文件处理参数和变量而改变。
27
27|
28
28|
29
29|- ** 文档处理 ** 跟踪文档处理的进度。嵌入完成后，点击 ** 前往文档 **。
30
30|
31
31|
32
32|- ** 查看文件列表 ** 点击 ** 前往文档 **，前往知识库文档界面。在这里，你可以浏览上传文件数量、处理进程和状态等。
33
33|

1
 1|# 知识库请求频率限制
2
 2|
3
 3|> 原文：[知识库请求频率限制](https://docs.dify.ai/zh/use-dify/knowledge/knowledge-request-rate-limit)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/knowledge-request-rate-limit)。
11
11|
12
12|
13
13|## 什么是知识库请求频率限制？在 Dify Cloud 上，知识库请求频率限制指一个工作区在知识库中每分钟可执行的最大操作数。这些操作包括数据集创建、文档管理，以及在应用或工作流中的知识库查询。
14
14|
15
15|
16
16|## 不同订阅版本的限制
17
17|- **Sandbox**：10 次 / 分钟
18
18|- **Professional**：100 次 / 分钟
19
19|- **Team**：1,000 次 / 分钟例如，对于 **Sandbox 用户 **，如果在 1 分钟内执行了 10 次命中测试，该用户的工作区将在接下来的 1 分钟内暂时无法执行受知识库请求频率限制的操作。
20
20|
21
21|
22
22|## 哪些操作会受到知识库请求频率限制？当你执行以下操作时，会受到知识库请求频率限制：
23
23|
24
24|
25
25|- 创建空数据集
26
26|- 删除数据集
27
27|- 更新数据集设置
28
28|- 上传文档
29
29|- 删除文档
30
30|- 更新文档
31
31|- 禁用文档
32
32|- 启用文档
33
33|- 归档文档
34
34|- 恢复文档
35
35|- 暂停文档处理
36
36|- 恢复文档处理
37
37|- 新增分段
38
38|- 删除分段
39
39|- 更新分段
40
40|- 批量导入分段
41
41|- 命中测试
42
42|- App 或 Workflow 中查询知识库（多路召回虽然会多次查询知识库，但是只记作一次请求）
43
43|

1
 1|# 调整知识库设置
2
 2|
3
 3|> 原文：[调整知识库设置](https://docs.dify.ai/zh/use-dify/knowledge/manage-knowledge/introduction)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/manage-knowledge/introduction)。
11
11|
12
12|
13
13|> 💡 只有工作区所有者、管理员和编辑者可修改知识库设置。
14
14|
15
15|
16
16|在知识库中，点击左侧边栏的 ** 设置 ** 图标，进入设置页。
17
17|
18
18|设置项说明名称和图标用于标识和区分知识库。描述简要说明知识库的用途和内容。权限定义哪些工作区成员可访问该知识库。
19
19|> ⚠️ 被授予访问权限的成员将拥有[维护知识库内容](/zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents) 中列出的全部权限。
20
20|
21
21|索引方式决定文档分段的处理和组织方式。详见[选择索引方式](/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods#%E9%80%89%E6%8B%A9%E7%B4%A2%E5%BC%95%E6%96%B9%E5%BC%8F)。嵌入模型选择用于将文档分段转化为向量的嵌入模型。
22
22|> 💡 更换嵌入模型将对所有分段重新进行向量化。
23
23|
24
24|摘要自动生成自动为文档分段生成摘要。
25
25|> 💡 启用后，仅对新添加的文档和分段生效。对于已有分段，请在文档列表中选择文档，然后点击 ** 生成摘要 **。
26
26|
27
27|检索设置决定知识库如何检索相关内容。详见[指定检索设置](/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods#%E6%8C%87%E5%AE%9A%E6%A3%80%E7%B4%A2%E8%AE%BE%E7%BD%AE)。
28
28|

1
 1|# 通过 API 维护知识库
2
 2|
3
 3|> 原文：[通过 API 维护知识库](https://docs.dify.ai/zh/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|Dify 提供了一套完整的知识库 API，可以通过编程方式管理知识库、文档和分段。这对于自动化数据同步或将知识库操作集成到 CI/CD 流程中非常有用。
11
11|
12
12|创建知识库时，API 访问默认开启。要开始调用 API，你只需要 API 凭据：一个端点和一个密钥。
13
13|
14
14|
15
15|> 💡 单个知识库 API 密钥可以访问同一账号下的 ** 所有可见知识库 **。请妥善保管凭据，避免意外的数据泄露。
16
16|
17
17|
18
18|## 获取 API 端点和密钥在 Dify 中进入 ** 知识库 ** 页面。点击右上角的 ** 服务 API** 打开 API 配置面板。在这里你可以：
19
19|
20
20|
21
21|- 获取服务 API 端点，即所有知识库 API 请求的基础 URL。
22
22|
23
23|
24
24|- 点击 **API 密钥 ** 创建新密钥并管理已有密钥。
25
25|
26
26|
27
27|> 💡 请将 API 密钥安全存储在服务端，切勿在客户端代码或公开仓库中暴露。
28
28|
29
29|
30
30|## 管理知识库的 API 访问权限每个知识库默认都可通过服务 API 访问。
31
31|
32
32|如果需要限制某个知识库的 API 访问，打开该知识库，点击左下角的 ** 访问 API** 并将其关闭。
33
33|
34
34|
35
35|## API 参考有关完整的端点列表、请求 / 响应结构、错误码和交互式示例，请参阅[知识库 API 参考](https://docs.dify.ai/api-reference/%E7%9F%A5%E8%AF%86%E5%BA%93/%E8%8E%B7%E5%8F%96%E7%9F%A5%E8%AF%86%E5%BA%93%E5%88%97%E8%A1%A8)。
36
36|

1
 1|# 维护知识库内容
2
 2|
3
 3|> 原文：[维护知识库内容](https://docs.dify.ai/zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents)。
11
11|
12
12|
13
13|## 管理文档在知识库中，每个导入的项——无论是本地文件、Notion 页面还是网页——都会成为一个文档。
14
14|
15
15|你可以在文档列表中查看和管理所有文档，确保知识库的内容始终准确、相关且最新。
16
16|
17
17|
18
18|> 💡 点击顶部的知识库名称，可快速切换不同知识库。
19
19|
20
20|
21
21|操作说明添加导入新文档。修改分段设置修改文档的分段设置（不包括分段结构）。
22
22|> 💡 每个文档可拥有独立的分段设置，但分段结构在整个知识库中共享，且一旦设置无法更改。
23
23|
24
24|删除永久删除文档。** 删除不可撤销 **。启用 / 禁用临时将文档纳入或排除检索。
25
25|> ⚠️ 在 Dify Cloud 上，长时间未更新或未被检索的文档会自动禁用以优化性能。不同订阅计划的未活跃时长如下：
26
26|- Sandbox：7 天
27
27|- Professional & Team：30 天 Professional 和 Team 用户可 ** 一键 ** 重新启用这些文档。
28
28|
29
29|生成摘要自动为文档中的所有分段生成摘要。仅适用于启用了 ** 摘要自动生成 ** 功能的自托管部署。
30
30|> ⚠️ 已有的摘要将被覆盖。
31
31|
32
32|归档 / 取消归档将不再需要检索但仍需保留的文档归档。归档文档为只读，可随时取消归档。编辑通过编辑分段内容修改文档。详见[管理分段](#%E7%AE%A1%E7%90%86%E5%88%86%E6%AE%B5)。重命名修改文档名称。
33
33|## 管理分段根据其分段设置，每个文档被拆分为一个或多个分段，而分段是检索的基本单元。
34
34|
35
35|你可以在文档的分段列表中查看和管理所有分段，以提升检索效率与准确性。
36
36|
37
37|
38
38|> 💡 点击左上角的文档名称，可快速切换不同文档。
39
39|
40
40|
41
41|操作说明添加新增或批量新增分段。对于采用父子分段模式的文档，可同时新增父分段和子分段。
42
42|> 💡 「添加分段」在 Dify Cloud 上为付费功能，[升级至 Professional 或 Team 版](https://dify.ai/pricing) 即可解锁使用。
43
43|
44
44|删除永久删除分段。** 删除不可撤销 **。启用 / 禁用临时将分段纳入或排除检索。已禁用的分段不可编辑。编辑修改分段内容。已编辑的分段将标记为 ** 已编辑 **。对于采用父子分段模式的知识库：
45
45|- 编辑父分段时，可选择重新生成其子分段或保持原有的子分段不变。
46
46|- 编辑子分段不会改变其父分段。添加 / 编辑 / 删除关键词为分段添加或修改关键词（最多 10 个），以提升其可检索性。仅适用于使用经济索引方式的知识库。添加 / 删除图片附件在对应分段中，删除从文档中提取的图片或上传新图片。提取的图片 URL 会保留在分段文本中，你可以安全地删除这些 URL 以保持文本简洁——这不会影响已提取的图片。
47
47|> ⚠️ 每个分段最多支持 10 张图片附件，在检索中将被一同返回；超过数量的图片不会被提取。对于自托管部署，可通过修改环境变量`SINGLE_CHUNK_ATTACHMENT_LIMIT`调整此数量限制。
48
48|
49
49|
50
50|> 💡 若选择多模态嵌入模型（带有 **Vision** 图标），提取的图片也将被向量化并索引以供检索。
51
51|
52
52|添加 / 编辑 / 删除摘要为分段添加、修改或删除摘要。摘要同样会被向量化并索引以供检索。当摘要与查询匹配时，其对应的分段也会被返回。
53
53|> 💡 为多个分段添加相同的摘要，可实现分组检索，使相关分段能够一同返回（受 Top K 限制）。
54
54|
55
55|
56
56|## 最佳实践
57
57|### 检查分段质量文档完成分段后，仔细检查每个分段，确保其语义完整、长度适中，以保证检索准确性和回复相关性。
58
58|
59
59|常见问题包括：
60
60|
61
61|
62
62|- 分段 ** 过短 **：上下文不完整，易造成语义丢失和答案不准确。
63
63|
64
64|
65
65|- 分段 ** 过长 **：包含无关信息，易引入语义噪音、降低检索精度。
66
66|
67
67|
68
68|- 分段 ** 语义不完整 **：句子或段落被分段设置强制切断，易导致检索结果存在内容缺失或误导。
69
69|
70
70|
71
71|### 将子分段用作父分段的检索钩子对于采用父子分段模式的文档，系统会在子分段中进行搜索，但返回的是父分段。由于编辑子分段不会改变其父分段，可将子分段作为父分段的语义标签或检索提示。
72
72|
73
73|具体做法是将子分段改写为 ** 关键词 **、** 摘要 ** 或 ** 常见用户问题 **。例如，若父分段的内容涉及技术性的”LED 状态指示灯”，可将子分段改写为：
74
74|
75
75|
76
76|- * 闪烁灯、无法开机、红灯、连接错误、卡死 *（关键词）
77
77|
78
78|
79
79|- *LED 颜色解读及硬件电源或配对问题排查指南 *（摘要）
80
80|
81
81|
82
82|- * 常亮红灯是什么意思？*（问题）
83
83|
84
84|
85
85|### 使用摘要弥合查询与内容之间的差距虽然高质量的索引可以实现语义搜索，但当原始分段过于具体、包含噪音或结构复杂时，仍然难以与用户查询良好匹配。
86
86|
87
87|摘要通过提供一个精简的语义层来弥合这一差距，使分段的核心意图更加明确。
88
88|
89
89|在以下情况下使用摘要：
90
90|
91
91|
92
92|- ** 用户查询与文档语言不同 **：对于正式书写的技术文档，按照用户实际提问的方式添加摘要。
93
93|
94
94|
95
95|- ** 概念隐含或埋没在细节中 **：添加高层次的摘要，提炼核心概念和意图，使分段能够被匹配，而不依赖于分散在文本中的细枝末节。
96
96|
97
97|
98
98|- ** 原始文本是非文本内容 **：当分段主要是代码、表格、日志、记录稿或其他难以进行语义匹配的内容时，添加描述性摘要，清楚标注分段包含的内容。
99
99|

1
 1|# 管理文档元数据
2
 2|
3
 3|> 原文：[管理文档元数据](https://docs.dify.ai/zh/use-dify/knowledge/metadata)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/metadata)。
11
11|
12
12|
13
13|## 什么是元数据？
14
14|### 定义元数据是用于描述其他数据的信息。简单来说，它是”关于数据的数据”。它就像一本书的目录或标签，可以为你介绍数据的内容、来源和用途。
15
15|通过提供数据的上下文，元数据能帮助你在知识库内快速查找和管理数据。
16
16|
17
17|
18
18|### 知识库元数据定义
19
19|- ** 字段（Field）**：元数据字段是用于描述文档特定属性的标识项，每个字段代表文档的某个特征或信息。例如”author""language”等。
20
20|
21
21|
22
22|- ** 字段值（Value）**：字段值是该字段的具体信息或属性，例如”Jack""English”。
23
23|
24
24|
25
25|- ** 字段值计数（Value Count）**：字段值计数是指在某条元数据字段中标记的字段值数量，包括重复项。例如，此处的”3”是字段值计数，指该字段中有 3 个独特的字段值。
26
26|
27
27|
28
28|- ** 值类型（Value Type）**：值类型指字段值的类型。
29
29|- 目前，Dify 的元数据功能支持以下三种值类型：
30
30|- ** 字符串 **（String）：文本值。
31
31|- ** 数字 **（Number）：数值。
32
32|- ** 时间 **（Time）：日期和时间。
33
33|
34
34|
35
35|## 如何管理知识库元数据？
36
36|### 管理知识库元数据字段在知识库管理界面，你可以创建、修改和删除元数据字段。
37
37|
38
38|注意：所有在此界面进行的更新均为 ** 全局更新 **，这意味着对元数据字段列表的任何更改都会影响整个知识库，包括所有文档中标记的元数据。
39
39|
40
40|
41
41|#### 元数据管理界面简介 ** 进入元数据管理界面 **
42
42|
43
43|在知识库管理界面，点击右上方的 ** 元数据 ** 按钮，进入元数据管理界面。
44
44|
45
45|
46
46|** 知识库元数据字段的类型 **
47
47|
48
48|在知识库中，元数据字段分为两类：** 内置元数据（Built-in）** 和 ** 自定义元数据 **。
49
49|
50
50|内置元数据（Built-in）自定义元数据显示位置知识库界面 元数据 栏的下半部分。知识库界面 元数据 栏的上半部分。启用方式默认禁用，需要手动开启才能生效。由用户根据需求自由添加。生成方式启用后，由系统自动提取相关信息并生成字段值。用户手动添加，完全由用户自定义。修改权限一旦生成，无法修改字段与字段值。可以删除或编辑字段名称，也可以修改字段值。应用范围启用后，适用于已上传和新上传的所有文档。添加元数据字段后，字段会储存在知识库的元数据列表中 / 需要手动设置，才能将该字段应用于具体文档。字段由系统预定义，包括：
51
51|
52
52|
53
53|- document_name (string)：文件名
54
54|- uploader (string)：上传者
55
55|- upload_date (time)：上传日期
56
56|- last_update_date (time)：最后更新时间
57
57|- source (string)：文件来源在初始状态下，知识库无自定义元数据字段，需要用户手动添加。字段值类型
58
58|- 字符串 (string)：文本值
59
59|- 数字 (number)：数值
60
60|- 时间 (time)：日期和时间
61
61|- 字符串 (string)：文本值
62
62|- 数字 (number)：数值
63
63|- 时间 (time)：日期和时间
64
64|#### 新建元数据字段
65
65|- 点击 **+ 添加元数据 ** 按钮，弹出 ** 新建元数据 ** 弹窗。
66
66|
67
67|
68
68|- 在 ** 字段值类型 ** 中选择元数据字段的值类型。
69
69|
70
70|
71
71|- 在 ** 名称 ** 框中填写字段的名称。
72
72|
73
73|字段名仅支持小写字母、数字和下划线（_）字符，不支持空格和大写字母。
74
74|
75
75|
76
76|- 点击 ** 保存 ** 按钮，保存字段。
77
77|
78
78|
79
79|#### 修改元数据字段
80
80|- 点击单条元数据字段右侧的编辑按钮，弹出 ** 重命名 ** 弹窗。
81
81|
82
82|
83
83|- 在 ** 名称 ** 框中修改字段名称。此弹窗仅支持修改字段名称，不支持修改字段值类型。
84
84|
85
85|
86
86|- 点击 ** 保存 ** 按钮，保存修改后的字段。修改并保存后，该字段将在知识库中的所有相关文档中同步更新。
87
87|
88
88|
89
89|#### 删除元数据字段点击单条元数据字段右侧的删除按钮，可以删除该字段。
90
90|
91
91|如果删除单条字段，该字段及该字段下包含的字段值将从知识库的所有文档中删除。
92
92|
93
93|
94
94|### 编辑文档元数据信息
95
95|#### 批量编辑文档元数据信息你可以在知识库管理界面批量编辑文档的元数据信息。
96
96|
97
97|** 打开编辑元数据弹窗 **
98
98|
99
99|

1
 1|# 知识库
2
 2|
3
 3|> 原文：[知识库](https://docs.dify.ai/zh/use-dify/knowledge/readme)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/readme)。
11
11|
12
12|
13
13|## 简介在 Dify 中，你可以将自有数据作为「知识」集成到 AI 应用中。通过为大语言模型（LLM）提供特定领域的上下文信息，知识能够让 LLM 的回复更加准确、相关，并显著减少幻觉。
14
14|
15
15|这得益于检索增强生成（RAG）技术。其核心在于：LLM 不再只依赖预训练的公开数据，还会将你的自定义知识作为额外的事实来源：
16
16|
17
17|
18
18|- （检索）处理用户提问时，系统会先从已集成的知识库中 ** 检索最相关的信息 **。
19
19|- （增强）检索到的信息会与用户的原始问题打包，作为 ** 增强的上下文 ** 发送给 LLM。
20
20|- （生成）LLM 基于这些上下文 ** 生成更精准的答案 **。知识存储在知识库中。你可以创建多个知识库，分别适配不同领域、场景或数据源，并按需集成到应用中。
21
21|
22
22|
23
23|## 应用场景借助 Dify 知识库，你可以打造基于自有数据和特定领域知识的 AI 应用。常见场景包括：
24
24|
25
25|
26
26|- ** 智能客服机器人 **：让问答机器人基于最新的产品文档、FAQ 和故障排查指南，智能回复客户问题。
27
27|- ** 企业内部知识门户 **：为员工构建 AI 搜索与问答系统，快速查询公司政策与流程。
28
28|- ** 内容生成工具 **：根据特定背景资料，智能生成报告、文章或邮件。
29
29|- ** 科研与分析应用 **：检索和总结学术论文、市场报告、法律文档等专业知识，辅助研究与分析。
30
30|## 创建知识库
31
31|- **[快速创建](/zh/use-dify/knowledge/create-knowledge/introduction)**：导入数据，设置处理规则，其余一切交给 Dify。简单高效，新手友好。
32
32|- **[通过知识流水线创建](/zh/use-dify/knowledge/knowledge-pipeline/readme)**：自定义步骤和插件，编排更复杂、灵活的数据处理流程。
33
33|- **[连接外部知识库](/zh/use-dify/knowledge/connect-external-knowledge-base)**：通过 API 直接同步外部知识库，无需迁移即可利用现有数据。
34
34|## 管理与优化知识库
35
35|- **[维护知识库内容](/zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents)**：对文档及其分段进行查看、添加、修改和删除等操作，使知识库内容保持最新、准确、相关。
36
36|- **[测试召回效果](/zh/use-dify/knowledge/test-retrieval)**：模拟用户提问，测试知识库召回效果。
37
37|- **[利用元数据增强检索](/zh/use-dify/knowledge/metadata)**：为文档添加元数据，实现基于文档筛选的检索，进一步提升检索精度。
38
38|- **[调整知识库设置](/zh/use-dify/knowledge/manage-knowledge/introduction)**：随时调整索引方式、嵌入模型和检索策略等设置。
39
39|## 使用知识库 **[集成到应用](/zh/use-dify/knowledge/integrate-knowledge-within-application)**：将自定义知识集成到你的 AI 应用中。
40
40|
41
41|** 延伸阅读 **：
42
42|
43
43|
44
44|- [Dify v1.1.0 发布：用元数据给知识库“贴标签”，RAG 检索效率翻倍](https://mp.weixin.qq.com/s/Zvyz9tS2jmPaLo7Bi9y5LA)
45
45|
46
46|
47
47|- [Dify v0.15.0：全新父子检索策略 - 更精准，更全面的知识检索](https://mp.weixin.qq.com/s/YCvxXVjKjIeOpTNf4NRkYQ)
48
48|
49
49|
50
50|- [引入混合检索（Hybrid Search）和重排序（Rerank）改进 RAG 系统召回效果](https://mp.weixin.qq.com/s/57Wb0EcvgHzLO_XetTnRLg)
51
51|
52
52|
53
53|- [文本 Embedding 基本概念和应用实现原理](https://mp.weixin.qq.com/s/sYGxvx-qsu8xaIe2gb5haQ)
54
54|
55
55|
56
56|- [Dify.AI x Jina AI：Dify Embedding 模型新添助力 —— jina-embeddings-v2](https://mp.weixin.qq.com/s/k9-k1ONpRubRV4sKwuAhcg)
57
57|

1
 1|# 测试检索
2
 2|
3
 3|> 原文：[测试检索](https://docs.dify.ai/zh/use-dify/knowledge/test-retrieval)
4
 4|
5
 5|---
6
 6|
7
 7|## Documentation IndexFetch the complete documentation index at:[https://docs.dify.ai/llms.txt](https://docs.dify.ai/llms.txt)
8
 8|
9
 9|
10
10|> ⚠️ ⚠️ 本文档由 AI 自动翻译。如有任何不准确之处，请参考[英文原版](/en/use-dify/knowledge/test-retrieval)。
11
11|
12
12|在知识库中，点击左侧边栏的 ** 检索测试 ** 图标，进入测试页面。在这里，可模拟用户提问以测试知识库的检索效果，并尝试不同的检索设置以获得最佳结果。
13
13|
14
14|
15
15|> ⚠️ 在召回测试中调整的检索设置，仅在当前测试会话中临时生效。
16
16|
17
17|
18
18|> 💡 关于检索参数的更多说明，阅读[指定检索设置](/zh/use-dify/knowledge/create-knowledge/setting-indexing-methods#%E6%8C%87%E5%AE%9A%E6%A3%80%E7%B4%A2%E8%AE%BE%E7%BD%AE)。
19
19|
20
20|
21
21|** 记录 ** 板块记录与该知识库相关的所有检索事件，包括：
22
22|
23
23|
24
24|- 在 ** 召回测试 ** 页面进行的测试检索
25
25|- 由任何关联应用发起的常规检索请求（无论是测试还是生产环境）
26
26|> 💡 召回测试与常规检索共用一个 API 接口。
27
27|