BatchPutDocument - 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.

BatchPutDocument

Añade uno o más documentos a un índice.

LaBatchPutDocumentLa API le permite ingerir documentos en línea o un conjunto de documentos almacenados en un bucket de Amazon S3. Utilice esta API para incorporar el texto y el texto no estructurado en un índice, añadir atributos personalizados a los documentos y adjuntar una lista de control de acceso a los documentos agregados al índice.

Los documentos se indexan de forma asíncrona. Puede ver el progreso del lote medianteAWS CloudWatch. Los mensajes de error relacionados con el procesamiento del lote se envían a tuAWS CloudWatch registro.

Para ver un ejemplo de incorporación de documentos en línea con los SDK de Python y Java, consulteAdición de archivos directamente a un índice.

Sintaxis de la solicitud

{ "CustomDocumentEnrichmentConfiguration": { "InlineConfigurations": [ { "Condition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "DocumentContentDeletion": boolean, "Target": { "TargetDocumentAttributeKey": "string", "TargetDocumentAttributeValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "TargetDocumentAttributeValueDeletion": boolean } } ], "PostExtractionHookConfiguration": { "InvocationCondition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "LambdaArn": "string", "S3Bucket": "string" }, "PreExtractionHookConfiguration": { "InvocationCondition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "LambdaArn": "string", "S3Bucket": "string" }, "RoleArn": "string" }, "Documents": [ { "AccessControlConfigurationId": "string", "AccessControlList": [ { "Access": "string", "DataSourceId": "string", "Name": "string", "Type": "string" } ], "Attributes": [ { "Key": "string", "Value": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" } } ], "Blob": blob, "ContentType": "string", "HierarchicalAccessControlList": [ { "PrincipalList": [ { "Access": "string", "DataSourceId": "string", "Name": "string", "Type": "string" } ] } ], "Id": "string", "S3Path": { "Bucket": "string", "Key": "string" }, "Title": "string" } ], "IndexId": "string", "RoleArn": "string" }

Parámetros de solicitud

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

La solicitud acepta los siguientes datos en formato JSON.

CustomDocumentEnrichmentConfiguration

Información de configuración para modificar los metadatos y el contenido del documento durante el proceso de ingesta de documentos cuando utiliza elBatchPutDocumentAPI.

Para obtener más información sobre cómo crear, modificar y eliminar metadatos de documentos, o realizar otras alteraciones en el contenido al incorporar documentos en Amazon Kendra, consultePersonalización de metadatos de documentos durante el proceso de ingesta.

Tipo: objeto CustomDocumentEnrichmentConfiguration

Obligatorio: No

Documents

Uno o más documentos para añadir al índice.

Los documentos tienen los siguientes límites de tamaño de archivo.

  • Tamaño total de 5 MB para documentos en línea

  • 50 MB de tamaño total para archivos desde un bucket de S3

  • 5 MB de texto extraído para cualquier archivo

Para obtener más información sobre el tamaño del archivo y las cuotas de transacciones por segundo, consulteCuotas.

Type: Matriz deDocumentobjects

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 van a añadir los documentos. Primero debe crear el índice con laCreateIndexAPI.

Type: Cadena

Restricciones de longitud Longitud fija de 36.

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

Obligatorio: Sí

RoleArn

El nombre de recurso de Amazon (ARN) de un rol que tiene permiso para ejecutar elBatchPutDocumentAPI. Para obtener más información, consulteIAM Roles for Amazon Kendra.

Type: Cadena

Restricciones de longitud La longitud mínima es 0. La longitud máxima es de 1284 caracteres.

Patrón: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Obligatorio: No

Sintaxis de la respuesta

{ "FailedDocuments": [ { "ErrorCode": "string", "ErrorMessage": "string", "Id": "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.

FailedDocuments

Una lista de documentos que no se agregaron al índice porque el documento no pasó una comprobación de validación. Cada documento contiene un mensaje de error que indica por qué no se pudo añadir el documento al índice.

Si se produjo un error al añadir un documento a un índice, el error se informa en suAWS CloudWatch registro. Para obtener más información, consulteMonitorización de Amazon Kendra con Amazon CloudWatch Registros

Type: Matriz deBatchPutDocumentResponseFailedDocumentobjects

Errores

Para obtener información sobre los 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

ServiceQuotaExceededException

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: