Skip to main content
get/datasets/{dataset_id}/documents/{document_id}
Request example
Response
get/datasets/{dataset_id}/documents/{document_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。
document_idstringrequired#
文档 ID。从 获取知识库的文档列表 获取。

Query parameters

metadataenum<string>#
all 返回所有字段(包括元数据)。only 仅返回 id、doc_type 和 doc_metadata。without 返回除 doc_type 和 doc_metadata 外的所有字段。

Default: "all"

Options:allonlywithout

Responses

application/json
文档详情。返回的字段取决于 metadata 查询参数。
archivedboolean#
文档是否已归档。
average_segment_lengthnumber#
分段的平均字符长度。
completed_atnumber#
处理完成的 Unix 时间戳,尚未完成时为 null。
created_atnumber#
文档创建的 Unix 时间戳。
created_bystring#
创建该文档的用户 ID。
created_fromstring#
文档来源。通过 API 创建时为 api,通过 UI 创建时为 web。
data_source_infoobject#
数据源详情。文件上传时,此详情接口在 upload_file 下返回完整的文件对象,而列表接口仅返回 upload_file_id。
data_source_typestring#
文档的上传方式。文件上传为 upload_file,Notion 导入为 notion_import。
dataset_process_ruleobject#
知识库级别的处理规则配置。
dataset_process_rule_idstring#
应用于该文档的处理规则 ID。
disabled_atnumber#
文档被禁用的 Unix 时间戳,启用时为 null。
disabled_bystring#
禁用该文档的用户 ID,启用时为 null。
display_statusstring#
适合 UI 显示的索引状态。
doc_formstring#
文档分块模式。text_model 表示标准文本,hierarchical_model 表示父子结构,qa_model 表示问答对。
doc_languagestring#
文档内容的语言。
doc_metadataobject[]#
此文档的自定义元数据键值对。
doc_typestring#
文档类型分类,未设置时为 null。
document_process_ruleobject#
文档级别的处理规则配置。
enabledboolean#
该文档是否启用检索。
errorstring#
索引失败时的错误消息,否则为 null。
hit_countinteger#
该文档被检索的次数。
idstring#
文档标识符。
indexing_latencynumber#
索引耗时(秒),未完成时为 null。
indexing_statusstring#
当前索引状态,例如 waiting、parsing、cleaning、splitting、indexing、completed、error、paused。
namestring#
文档名称。
need_summaryboolean#
该文档是否需要生成摘要。
positioninteger#
在知识库中的位置索引。
segment_countinteger#
文档中的分段数。
summary_index_statusstring#
摘要索引的状态,未启用摘要索引时为 null。
tokensinteger#
文档中的令牌数。
updated_atnumber#
最后更新的 Unix 时间戳,从未更新时为 null。