查询知识库文件分片列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-beijing |
| KnowledgeBaseId |
string |
是 |
知识库唯一标识 |
pkb-xxxxx |
| FileId |
string |
是 |
文件 ID |
xxxx-xxxx-xxxx-xxxx |
| PageNumber |
integer |
否 |
页码 |
1 |
| PageSize |
integer |
否 |
每页记录数 |
30 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| PageNumber |
integer |
当前页码 |
1 |
| PageRecordCount |
integer |
本页记录数。 |
10 |
| PageSize |
integer |
分页查询时每页的条目数。 |
30 |
| RequestId |
string |
Id of the request |
3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF |
| Shards |
array<object> |
分片信息 |
|
|
array<object> |
|||
| Captions |
array |
分片关联的图或表标题列表 |
|
|
string |
图或表标题 |
系统架构图 |
|
| DocItems |
array |
分片关联的 Docling 源文档结构化元素引用列表，可用于精确定位原文元素 |
|
|
string |
Docling 源文档结构化元素引用 |
#/texts/2 |
|
| Headings |
array |
分片所属的章节标题链 |
|
|
string |
标题 |
概述 |
|
| ImageResources |
array<object> |
分片引用的图片资源列表 |
|
|
object |
图片资源 |
||
| DocumentIndex |
integer |
图片所属源文档的序号，从 0 开始 |
0 |
| Id |
string |
图片资源唯一标识 |
document-0/pictures/1 |
| ItemRef |
string |
图片在 Docling 源文档结构中的元素引用 |
#/pictures/1 |
| MimeType |
string |
图片资源的媒体类型 |
image/png |
| Uri |
string |
图片资源的 OSS URI |
oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png |
| PageNumbers |
array |
分片所属的页码列表 |
|
|
string |
页码 |
1 |
|
| ShardContent |
string |
分片文本内容 |
****** |
| ShardIndex |
integer |
分片序号 |
1 |
| TotalRecordCount |
integer |
总记录数。 |
10 |
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"PageRecordCount": 10,
"PageSize": 30,
"RequestId": "3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF",
"Shards": [
{
"Captions": [
"系统架构图"
],
"DocItems": [
"#/texts/2"
],
"Headings": [
"概述"
],
"ImageResources": [
{
"DocumentIndex": 0,
"Id": "document-0/pictures/1",
"ItemRef": "#/pictures/1",
"MimeType": "image/png",
"Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
}
],
"PageNumbers": [
"1"
],
"ShardContent": "******",
"ShardIndex": 1
}
],
"TotalRecordCount": 10
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。