获取文档详情
更新时间：2026-03-02
POST
https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeDocument
该接口用于根据文档ID查询文档详情信息。
权限说明
调用本文API，需使用API Key鉴权方式。使用API Key鉴权调用API流程，具体调用流程，请查看认证鉴权。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
documentId
string
文档ID。
必选
请求结构
POST /v2/knowledgeBase?Action=DescribeDocument HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"knowledgeBaseId": "7d1ef57f-****-****-9b81-12d743f95ca3",
"documentId": "7c20b0fd-****-****-a175-4bfd8a33f598"
}示例代码
请求示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeDocument' \
--header 'Authorization: Bearer <API Key>' \
--header 'Content-Type: application/json' \
--data '{
"knowledgeBaseId": "7d1ef57f-****-****-9b81-12d743f95ca3",
"documentId": "7c20b0fd-****-****-a175-4bfd8a33f598"
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
requestId
string
请求ID。
必选
documentId
string
文档ID，与请求参数一致。
必选
knowledgeBaseId
string
文档所属知识库ID，与请求参数一致。
必选
name
string
上传时的文档名。
必选
createdAt
string
创建时间，UTC时间格式。
必选
status
string
文档上传后的状态。
必选
meta
object {10}
文件原数据。
必选
显示子属性
隐藏子属性
source
string
文件来源：
local：本地上传数据bos：bos导入数据url：网页数据
必选
wordCount
integer
文件字数，表格型文件暂不支持读取字数，返回为0。
必选
mimeType
string
文件类型。
若通过url方式导入的文件，文件类型为url。
可选
fileSize
integer
文件大小，单位bytes。
可选
url
string
原文件下载链接。
可选
tags
array
文件标签列表。
可选
显示子属性
隐藏子属性
items
object {2}
显示子属性
隐藏子属性
key
string
标签键。
可选
values
array
标签值列表。
可选
显示子属性
隐藏子属性
items
string
parser
array
解析算子：
layout：版面分析ocr：图片文字识别（OCR）table：表格深度解析formular：文档公式解析vlm：图片理解（VLM）chart：文档图表解析asr：音频解析
可选
显示子属性
隐藏子属性
items
string
chunking
object {6}
切片策略。
可选
显示子属性
隐藏子属性
mode
string
切片模式。
default：默认切片策略，切片最大长度为600、相邻切片重叠0%，仅开启文字提取。custom：自定义切片onePage：整文件切片byPage：按页切分
可选
splitPattern
array
切片正则表达式，当mode是自定义切片时，需要返回这个参数。
可选
显示子属性
隐藏子属性
items
string
prepend
array
chunking 关联元数据：
title：增加标题filename：增加文件名
可选
显示子属性
隐藏子属性
items
string
maxToken
integer
切片最大长度，当mode是自定义切片或按页切分时，需要返回这个参数，取值范围300-150000。
可选
overlap
float
切片重叠最大字数占比，当mode是自定义切片或按页切分时，需要返回这个参数，取值范围0-0.3。
可选
separators
array
文本分块的默认标点分隔符列表。
可选
显示子属性
隐藏子属性
items
string
augmentation
array
知识增强配置，不传该参数表示不开启知识增强。
faq：问题生成summarize：段落概要spo：三元组知识抽取spoken_query：口语化追问生成short_summary：段落短摘要table_chart_sentence_generation：图表/表格描述句生成
可选
显示子属性
隐藏子属性
items
string
enableGraph
boolean
知识图谱配置是否开启。
可选
JSON
{
"requestId": "9585a164-e249-476e-8a5f-6c4b8983abb9",
"knowledgeBaseId": "58d5ad28-****-4ce9-8d26-149680c1932e",
"documentId": "728e1c30-b256-****-96b1-f5c5d1ff7709",
"name": "知识库检索.md",
"createdAt": "2025-12-12T02:54:53Z",
"status": "available",
"meta": {
"source": "local",
"wordCount": 174839,
"mimeType": "md",
"fileSize": 195571,
"url": "https://copilot-engine-bos.bj.bcebos.com/ai-dev-platform/datasets/2025-12-12/47996032-9ed5-4a9c-adaa-0dc1409ec54f/0795520c-89d8-****-2cf2fb9a12f7/%E7%9F%A5%E8%AF%86%E5%BA%93%E6%A3%80%E7%B4%A2.md?authorization=bce-auth-v1%2FALTAKeaCdRzQn6yAJOMoDW7S7s%2F2026-02-28T06%3A13%3A59Z%2F3600%2F%2Fc8883de0cd87922b0af84c602bdcb4d489b5d622bca610c9c4fbbcd941af6a0f",
"tags": [],
"parser": [
"layout",
"table",
"chart",
"ocr"
],
"chunking": {
"mode": "default",
"splitPattern": [],
"separators": [
"。",
"！",
"？",
"!",
"?",
"……",
"|\n"
],
"maxToken": 600,
"overlap": 0.0,
"prepend": []
},
"augmentation": [
"faq",
"spoken_query",
"short_summary",
"spo",
"table_chart_sentence_generation"
],
"enableGraph": false
}
}JSON
{
"code": "InvalidRequestArgumentError",
"message": "Parameter 'documentId' must not be empty",
"requestId": "59babe8e-956e-4fec-ac70-d03f439f819e"
}