通过 API 维护知识库

鉴权、调用方式与应用 Service API 保持一致,不同之处在于,所生成的单个知识库 API token 具备操作当前账号下所有可见知识库的权限,请注意数据安全。

使用知识库 API 的优势

通过 API 维护知识库可大幅提升数据处理效率,你可以通过命令行轻松同步数据,实现自动化操作,而无需在用户界面进行繁琐操作。

主要优势包括:

  • 自动同步: 将数据系统与 Dify 知识库无缝对接,构建高效工作流程;

  • 全面管理: 提供知识库列表,文档列表及详情查询等功能,方便你自建数据管理界面;

  • 灵活上传: 支持纯文本和文件上传方式,可针对分段(Chunks)内容的批量新增和修改操作;

  • 提高效率: 减少手动处理时间,提升 Dify 平台使用体验。

如何使用

进入知识库页面,在左侧的导航中切换至 API 页面。在该页面中你可以查看 Dify 提供的知识库 API 文档,并可以在 API 密钥 中管理可访问知识库 API 的凭据。

Knowledge API Document

API 调用示例

通过文本创建文档

此接口基于已存在知识库,在此知识库的基础上通过文本创建新的文档。

输入示例:

输出示例:

通过文件创建文档

此接口基于已存在知识库,在此知识库的基础上通过文件创建新的文档。

输入示例:

输出示例:

创建空知识库

输入示例:

输出示例:

知识库列表

输入示例:

输出示例:

删除知识库

输入示例:

输出示例:

通过文本更新文档

此接口的功能是,在已存在知识库的基础上,通过文本更新文档。

输入示例:

输出示例:

通过文件更新文档

此接口基于已存在知识库,在此知识库的基础上通过文件更新文档的操作。

输入示例:

输出示例:

获取文档嵌入状态(进度)

输入示例:

输出示例:

删除文档

输入示例:

输出示例:

知识库文档列表

输入示例:

输出示例:

新增分段

输入示例:

输出示例:

查询文档分段

输入示例:

输出示例:

删除文档分段

输入示例:

输出示例:

更新文档分段

输入示例:

输出示例:

检索知识库

新增知识库元数据字段

输入示例:

输出示例:

修改知识库元数据字段

输入示例:

输出示例:

删除知识库元数据字段

输入示例:

输出示例:

启用/禁用知识库元数据中的内置字段

输入示例:

输出示例:

修改文档的元数据(赋值)

输入示例:

输出示例:

数据集的元数据列表

输入示例:

输出示例:

错误信息

示例:

错误信息
错误码
原因描述

no_file_uploaded

400

请上传你的文件

too_many_files

400

只允许上传一个文件

file_too_large

413

文件大小超出限制

unsupported_file_type

415

不支持的文件类型。目前只支持以下内容格式:txt, markdown, md, pdf, html, html, xlsx, docx, csv

high_quality_dataset_only

400

当前操作仅支持"高质量"知识库

dataset_not_initialized

400

知识库仍在初始化或索引中。请稍候

archived_document_immutable

403

归档文档不可编辑

dataset_name_duplicate

409

知识库名称已存在,请修改你的知识库名称

invalid_action

400

无效操作

document_already_finished

400

文档已处理完成。请刷新页面或查看文档详情

document_indexing

400

文档正在处理中,无法编辑

invalid_metadata

400

元数据内容不正确。请检查并验证

Last updated