Skip to main content
patch/datasets/{dataset_id}
Request example
Response
patch/datasets/{dataset_id}

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Path parameters

dataset_idstringrequired#
知识库 ID,通过 获取知识库列表 获取。使用限定范围的密钥时,从 Dify 页面 URL 复制 ID。

Body

application/json
descriptionstring#
知识库描述。

Length: max 400

embedding_modelstring#
嵌入模型名称。使用 获取可用模型 中 model_type=text-embedding 返回的 model 字段值。
embedding_model_providerstring#

嵌入模型供应商标识符,格式为 organization/plugin_name/provider_name(例如 langgenius/openai/openai)。openai 这类简写会展开为 langgenius/<name>/<name>,仅对 langgenius 发布的插件有效。

有效取值从 获取可用模型 中 model_type=text-embedding 返回的 provider 字段获取。

external_knowledge_api_idstring#
外部知识库 API 连接的 ID。
external_knowledge_idstring#
外部知识库的 ID。
external_retrieval_modelobject#
外部知识库的检索设置。
indexing_techniqueenum<string>#
high_quality 使用嵌入模型进行精确搜索;economy 使用基于关键词的索引。
Options:high_qualityeconomy
namestring#
知识库名称。

Length: 1–40

partial_member_listobject[]#
当 permission 为 partial_members 时有访问权限的团队成员列表。
permissionenum<string>#
控制谁可以访问此知识库。only_me 仅限创建者,all_team_members 授权整个工作区访问,partial_members 授权指定成员访问。
Options:only_meall_team_memberspartial_members
retrieval_modelobject#

Responses

application/json
知识库更新成功。
app_countinteger#
当前使用该知识库的应用数量。
author_namestring#
创建者的显示名称。
built_in_field_enabledboolean#
是否启用内置元数据字段(例如 document_name、uploader)。
chunk_structurestring#
分段结构配置。
created_atnumber#
创建时间戳(Unix 纪元,单位为秒)。
created_bystring#
创建该知识库的用户 ID。
data_source_typestring#
文档的数据源类型,尚未配置时为 null。
descriptionstring#
描述知识库用途或内容的可选文本。
doc_formstring#
文档分块模式。text_model 表示标准文本分块,hierarchical_model 表示父子结构,qa_model 表示问答对提取。
doc_metadataobject[]#
知识库的元数据字段定义。
document_countinteger#
知识库中的文档总数。
embedding_availableboolean#
配置的嵌入模型当前是否可用。
embedding_modelstring#
用于索引的嵌入模型名称。
embedding_model_providerstring#
嵌入模型供应商标识符,格式为 organization/plugin_name/provider_name(例如 langgenius/openai/openai)。旧版知识库可能返回简写形式(例如 openai)。
enable_apiboolean#
该知识库是否启用 API 访问。
external_knowledge_infoobject#
外部知识库的连接详情。当 provider 为 external 时存在。
external_retrieval_modelobject#
外部知识库的检索设置。内部知识库时为 null。
icon_infoobject#
知识库的图标显示配置。
idstring#
知识库的唯一标识符。
indexing_techniquestring#
high_quality 使用嵌入模型进行精确搜索;economy 使用基于关键词的索引。
is_multimodalboolean#
是否启用多模态内容处理。
is_publishedboolean#
知识库是否已发布。
maintainerstring#
知识库维护者的显示名称。未设置时为 null。
namestring#
知识库的显示名称。在工作区内唯一。
partial_member_liststring[]#
当 permission 为 partial_members 时被授予访问权限的成员账户 ID。更新响应中始终返回;详情响应中仅当 permission 为 partial_members 时返回。
permissionstring#
控制谁可以访问此知识库。可选值:only_me、all_team_members、partial_members。
pipeline_idstring#
自定义处理流水线的 ID(如果已配置)。
providerstring#
供应商类型。内部管理为 vendor,外部知识库连接为 external。
retrieval_model_dictobject#
知识库的检索配置。
runtime_modestring#
运行时处理模式。
summary_index_settingobject#
摘要索引配置。
tagsobject[]#
与该知识库关联的标签。
total_available_documentsinteger#
已启用且可用的文档数量。
total_documentsinteger#
文档总数。
updated_atnumber#
最后更新时间戳(Unix 纪元,单位为秒)。
updated_bystring#
最后更新该知识库的用户 ID。
word_countinteger#
所有文档的总字数。