StartExpenseAnalysis

Inicia el análisis asíncrono de facturas o recibos de datos como información de contacto, artículos comprados y nombres de proveedores.

StartExpenseAnalysispuede analizar el texto de documentos en formato JPEG, PNG y PDF. Los documentos deben almacenarse en un bucket de Amazon S3. UsarDocumentLocationpara especificar el nombre del bucket de S3 y el nombre del documento de ese bucket.

StartExpenseAnalysisdevuelve un identificador de trabajo (JobId) que proporcionarás aGetExpenseAnalysispara recuperar los resultados de la operación. Cuando finaliza el análisis de las facturas/recibos de entrada, Amazon Textract publica un estado de finalización en el tema Amazon Simple Notification Service (Amazon SNS) que proporciona alNotificationChannel. Para obtener los resultados de la operación de análisis de facturas y recibos, asegúrese de que el valor de estado publicado en el tema de Amazon SNS seaSUCCEEDED. Si es así, llameGetExpenseAnalysisy pasa el identificador de trabajo (JobId) que se devolvió mediante tu llamada aStartExpenseAnalysis.

Para obtener más información, consulteAnálisis de facturas y recibos.

Sintaxis de la solicitud

{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}

Parámetros de solicitud

La solicitud acepta los siguientes datos en formato JSON.

ClientRequestToken

El token idempotente que se utiliza para identificar la solicitud de inicio. Si utilizas el mismo token con variosStartDocumentTextDetectionsolicitudes, lo mismoJobIdse devuelve. UsarClientRequestTokenpara evitar que el mismo trabajo se inicie accidentalmente más de una vez. Para obtener más información, consulteLlamar a operaciones asíncronas de Amazon Textract

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9-_]+$

: obligatorio No

DocumentLocation

Ubicación del documento que se va a procesar.

Tipo: objeto DocumentLocation

: obligatorio Sí

JobTag

Identificador que especifique que se incluye en la notificación de finalización publicada en el tema de Amazon SNS. Por ejemplo, puede utilizarJobTagpara identificar el tipo de documento al que corresponde la notificación de finalización (como un formulario fiscal o un recibo).

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: [a-zA-Z0-9_.\-:]+

: obligatorio No

KMSKeyId

La clave KMS utilizada para cifrar los resultados de la inferencia. Puede estar en formato ID de clave o alias de clave. Cuando se proporciona una clave KMS, la clave KMS se utilizará para el cifrado del lado del servidor de los objetos del depósito de clientes. Cuando este parámetro no está habilitado, el resultado se cifrará en el lado del servidor mediante SSE-S3.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

: obligatorio No

NotificationChannel

Arn del tema de Amazon SNS en el que desea que Amazon Textract publique el estado de finalización de la operación.

Tipo: objeto NotificationChannel

: obligatorio No

OutputConfig

Establece si la salida va a ir a un depósito definido por el cliente. De forma predeterminada, Amazon Textract Texact guardará los resultados internamente para que pueda acceder a ellosGetExpenseAnalysis.

Tipo: objeto OutputConfig

: obligatorio No

Sintaxis de la respuesta

{
   "JobId": "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.

JobId

Un identificador único del trabajo de detección de texto. LaJobIdse devuelve desdeStartExpenseAnalysis. UNAJobIdEl valor solo es válido durante 7 días.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9-_]+$

Errores

AccessDeniedException

No tiene autorización para realizar la acción. Utilice el nombre de recurso de Amazon (ARN) de un usuario autorizado o un rol de IAM para realizar la operación.

Código de estado HTTP: 400

BadDocumentException

Amazon Textract Texact no puede leer el documento. Para obtener más información sobre los límites de documentos en Amazon Textract, consulteLímites máximos de Amazon Textract.

Código de estado HTTP: 400

DocumentTooLargeException

El documento no se puede procesar porque es demasiado grande. Tamaño máximo de documento para operaciones síncronas de 10 MB. El tamaño máximo de documento para las operaciones asíncronas es de 500 MB para los archivos PDF.

Código de estado HTTP: 400

IdempotentParameterMismatchException

UNAClientRequestTokenSe ha reutilizado con una operación, pero al menos uno de los demás parámetros de entrada es distinto de la llamada anterior a la operación.

Código de estado HTTP: 400

InternalServerError

Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.

Código de estado HTTP: 500

InvalidKMSKeyException

Indica que no tiene permisos de descifrado con la clave KMS introducida o que la clave KMS se ha introducido de forma incorrecta.

Código de estado HTTP: 400

InvalidParameterException

Un parámetro de entrada infringió una restricción. Por ejemplo, en operaciones sincrónicas, unInvalidParameterExceptionse produce cuando ninguno de losS3ObjectoByteslos valores se proporcionan en elDocumentparámetro de solicitud. Valide el parámetro antes de llamar a la operación de la API de nuevo.

Código de estado HTTP: 400

InvalidS3ObjectException

Amazon Textract Texact no puede obtener acceso al objeto de S3 especificado en la solicitud. Para obtener más información,Configuración del acceso a Amazon S3Para obtener información sobre la resolución de problemas, consulteSolución de problemas de Amazon S3

Código de estado HTTP: 400

LimitExceededException

Se ha superado un límite de servicio de Amazon Texact. Por ejemplo, si inicia demasiados trabajos asíncronos simultáneamente, llama para iniciar operaciones (StartDocumentTextDetection, por ejemplo) produce una excepción LimitExceededException (código de estado HTTP: 400) hasta que el número de trabajos ejecutados simultáneamente se encuentre por debajo del límite de servicio de Amazon Textract.

Código de estado HTTP: 400

ProvisionedThroughputExceededException

El número de solicitudes ha superado su límite de rendimiento. Si necesita aumentar este límite, póngase en contacto con Amazon Textract.

Código de estado HTTP: 400

ThrottlingException

Amazon Textract Texact no puede procesar temporalmente la solicitud. Pruebe la llamada de nuevo.

Código de estado HTTP: 500

UnsupportedDocumentException

No se admite el formato del documento de entrada. Los documentos para operaciones pueden estar en formato PNG, JPEG, PDF o TIFF.

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:

• AWS Command Line Interface

• SDK de AWS para .NET

• AWS SDK para C++

• AWS SDK para Go

• AWSSDK para Java V2

• AWS SDK para JavaScript

• SDK de AWS para PHP V3

• SDK de AWS para Python

• SDK de AWS para Ruby V3