获取文档详情
返回单个文档的详细信息。
1 min read
get/datasets/{dataset_id}/documents/{document_id}
Request example
Response
get/datasets/{dataset_id}/documents/{document_id}
Authorization
Path parameters
知识库 ID,通过 获取知识库列表 获取。使用限定范围的密钥时,从 Dify 页面 URL 复制 ID。
文档 ID。从 获取知识库的文档列表 获取。
Query parameters
all 返回所有字段(包括元数据)。only 仅返回 id、doc_type 和 doc_metadata。without 返回除 doc_type 和 doc_metadata 外的所有字段。Default: "all"
Options:
allonlywithoutResponses
application/json
文档详情。返回的字段取决于
metadata 查询参数。文档是否已归档。
分段的平均字符长度。
处理完成的 Unix 时间戳,尚未完成时为
null。文档创建的 Unix 时间戳。
创建该文档的用户 ID。
文档来源。通过 API 创建时为
api,通过 UI 创建时为 web。文档的上传方式。文件上传为
upload_file,Notion 导入为 notion_import。知识库级别的处理规则配置。
应用于该文档的处理规则 ID。
文档被禁用的 Unix 时间戳,启用时为
null。禁用该文档的用户 ID,启用时为
null。适合 UI 显示的索引状态。
文档分块模式。
text_model 表示标准文本,hierarchical_model 表示父子结构,qa_model 表示问答对。文档内容的语言。
文档类型分类,未设置时为
null。文档级别的处理规则配置。
该文档是否启用检索。
索引失败时的错误消息,否则为
null。该文档被检索的次数。
文档标识符。
索引耗时(秒),未完成时为
null。当前索引状态,例如
waiting、parsing、cleaning、splitting、indexing、completed、error、paused。文档名称。
该文档是否需要生成摘要。
在知识库中的位置索引。
文档中的分段数。
摘要索引的状态,未启用摘要索引时为
null。文档中的令牌数。
最后更新的 Unix 时间戳,从未更新时为
null。