获取文档详情
更新时间：2025-12-24
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 {6}
文件原数据。
必选
显示子属性
隐藏子属性
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
JSON
{
"requestId": "2709e08c-****-****-990f-f89d4b166979",
"knowledgeBaseId": "dca1697e-****-****-b0c6-ffcaaab810ea",
"documentId": "bf387697-****-****-bc9b-f85a7fa90969",
"name": "OG-RAG.pdf",
"createdAt": "2025-11-05T06:12:48Z",
"status": "available",
"meta": {
"source": "local",
"wordCount": 83264,
"mimeType": "pdf",
"fileSize": 930901,
"url": "https://copilot-engine-bos.bj.bcebos.com/ai-dev-platform/datasets/2025-11-05/f44e906f-92de-4631-b441-4cab6648dd29/c3dea056-5ad7-45e1-862e-04ae7f3ec52e/OG-RAG.pdf?authorization=*********dEDAzLm%2F2025-11-06T08%3A28%3A54Z%2F600%2F%2F5bb74dbdfd50c4958ffb933edf09e49d8ac85511cf392c617240f561b996f306",
"tags": [
{
"key": "论文",
"values": [
"rag"
]
},
{
"key": "产品",
"values": [
"千帆",
"百度",
"智能云"
]
}
]
}
}JSON
{
"code": "InvalidRequestArgumentError",
"message": "Parameter 'documentId' must not be empty",
"requestId": "59babe8e-956e-4fec-ac70-d03f439f819e"
}