Queries the list of file shards in a knowledge base.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-beijing |
| KnowledgeBaseId |
string |
Yes |
The unique ID of the knowledge base. |
pkb-xxxxx |
| FileId |
string |
Yes |
The file ID. |
xxxx-xxxx-xxxx-xxxx |
| PageNumber |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of records per page. |
30 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| PageNumber |
integer |
The current page number. |
1 |
| PageRecordCount |
integer |
The number of records on the current page. |
10 |
| PageSize |
integer |
The number of entries per page in a paged query. |
30 |
| RequestId |
string |
Id of the request |
3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF |
| Shards |
array<object> |
The shard information. |
|
|
array<object> |
|||
| Captions |
array |
The list of figure or table captions associated with the shard. |
|
|
string |
The figure or table caption. |
System architecture diagram |
|
| DocItems |
array |
The list of Docling source document structured element references associated with the shard. You can use these references to precisely locate original document elements. |
|
|
string |
The Docling source document structured element reference. |
#/texts/2 |
|
| Headings |
array |
The chain of section headings to which the shard belongs. |
|
|
string |
The heading. |
Overview |
|
| ImageResources |
array<object> |
The list of image resources referenced by the shard. |
|
|
object |
The image resource. |
||
| DocumentIndex |
integer |
The index of the source document to which the image belongs, starting from 0. |
0 |
| Id |
string |
The unique ID of the image resource. |
document-0/pictures/1 |
| ItemRef |
string |
The element reference of the image in the Docling source document structure. |
#/pictures/1 |
| MimeType |
string |
The media type of the image resource. |
image/png |
| Uri |
string |
The OSS URI of the image resource. |
oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png |
| PageNumbers |
array |
The list of page numbers to which the shard belongs. |
|
|
string |
The page number. |
1 |
|
| ShardContent |
string |
The text content of the shard. |
****** |
| ShardIndex |
integer |
The index of the shard. |
1 |
| TotalRecordCount |
integer |
The total number of records. |
10 |
Examples
Success response
JSON format
{
"PageNumber": 1,
"PageRecordCount": 10,
"PageSize": 30,
"RequestId": "3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF",
"Shards": [
{
"Captions": [
"系统架构图"
],
"DocItems": [
"#/texts/2"
],
"Headings": [
"Overview"
],
"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
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.