Consulta la lista de fragmentos de archivo de una base de conocimiento.
Pruébelo ahora
Test
Autorización de RAM
Sintaxis de la solicitud
POST HTTP/1.1Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| RegionId |
string |
Sí |
El ID de la región. |
cn-beijing |
| KnowledgeBaseId |
string |
Sí |
El ID único de la base de conocimiento. |
pkb-xxxxx |
| FileId |
string |
Sí |
El ID del archivo. |
xxxx-xxxx-xxxx-xxxx |
| PageNumber |
integer |
No |
El número de página. |
1 |
| PageSize |
integer |
No |
El número de registros por página. |
30 |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Esquema de la respuesta. |
||
| PageNumber |
integer |
El número de página actual. |
1 |
| PageRecordCount |
integer |
El número de registros en la página actual. |
10 |
| PageSize |
integer |
El número de entradas por página en una consulta paginada. |
30 |
| RequestId |
string |
El ID de la solicitud. |
3E5CD764-xxxx-xxxx-xxxx-20E0DE84B2AF |
| Shards |
array<object> |
La información de los fragmentos. |
|
|
array<object> |
|||
| Captions |
array |
La lista de títulos de figuras o tablas asociados al fragmento. |
|
|
string |
El título de la figura o de la tabla. |
Diagrama de arquitectura del sistema |
|
| DocItems |
array |
La lista de referencias de elementos estructurados del documento de origen de Docling asociadas al fragmento. Puede utilizar estas referencias para ubicar con precisión los elementos originales del documento. |
|
|
string |
La referencia del elemento estructurado del documento de origen de Docling. |
#/texts/2 |
|
| Headings |
array |
La cadena de encabezados de sección a la que pertenece el fragmento. |
|
|
string |
El encabezado. |
Descripción general |
|
| ImageResources |
array<object> |
La lista de recursos de imagen referenciados por el fragmento. |
|
|
object |
El recurso de imagen. |
||
| DocumentIndex |
integer |
El índice del documento de origen al que pertenece la imagen (comienza en 0). |
0 |
| Id |
string |
El ID único del recurso de imagen. |
document-0/pictures/1 |
| ItemRef |
string |
La referencia del elemento de la imagen en la estructura del documento de origen de Docling. |
#/pictures/1 |
| MimeType |
string |
El tipo de medio del recurso de imagen. |
image/png |
| Uri |
string |
El URI de OSS del recurso de imagen. |
oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png |
| PageNumbers |
array |
La lista de números de página a los que pertenece el fragmento. |
|
|
string |
El número de página. |
1 |
|
| ShardContent |
string |
El contenido de texto del fragmento. |
****** |
| ShardIndex |
integer |
El índice del fragmento. |
1 |
| TotalRecordCount |
integer |
El número total de registros. |
10 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"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
}Códigos de error
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.