BatchGetDocumentStatus - Amazon Kendra

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

BatchGetDocumentStatus

Devuelve el estado de indexación de uno o varios documentos enviados con elBatchPutDocumentAPI.

Cuando utiliza elBatchPutDocumentAPI, los documentos se indexan de forma asíncrona. Puede utilizar elBatchGetDocumentStatusAPI para obtener el estado actual de una lista de documentos para poder determinar si se han indexado correctamente.

También puede utilizar laBatchGetDocumentStatusAPI para comprobar el estado delEliminar documento por lotesAPI. Cuando se elimina un documento del índice, Amazon Kendra devuelveNOT_FOUNDcomo estado.

Sintaxis de la solicitud

{ "DocumentInfoList": [ { "Attributes": [ { "Key": "string", "Value": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" } } ], "DocumentId": "string" } ], "IndexId": "string" }

Parámetros de solicitud

Para obtener información sobre parámetros que son comunes a todas las acciones, consulteParámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

DocumentInfoList

Una lista deDocumentInfoobjetos que identifican los documentos para los que se desea obtener el estado. Identifica los documentos por su ID de documento y atributos opcionales.

Type: Matriz deDocumentInfoobjects

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 10 elementos.

Obligatorio: Sí

IndexId

El identificador del índice al que se va a agregar documentos. devuelve el ID de índiceCreateIndexAPI.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

Obligatorio: Sí

Sintaxis de la respuesta

{ "DocumentStatusList": [ { "DocumentId": "string", "DocumentStatus": "string", "FailureCode": "string", "FailureReason": "string" } ], "Errors": [ { "DocumentId": "string", "ErrorCode": "string", "ErrorMessage": "string" } ] }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

DocumentStatusList

Estado de los documentos. El estado indica si el documento está esperando ser indexado, está en proceso de indexación, ha finalizado la indexación o ha fallado la indexación. Si un documento falla en la indexación, el estado indica el motivo por el cual.

Type: Matriz deStatusobjects

Errors

Lista de documentos para los que Amazon Kendra no ha podido obtener el estado. La lista incluye el ID del documento y el motivo por el que no se ha encontrado el estado.

Type: Matriz deBatchGetDocumentStatusResponseErrorobjects

Errores

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

Código de estado HTTP: 400

ConflictException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

Código de estado HTTP: 400

ThrottlingException

Código de estado HTTP: 400

ValidationException

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: