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.
# Acciones
Se admiten las siguientes acciones:
+ [AnalyzeDocument](API_AnalyzeDocument.md)
+ [AnalyzeExpense](API_AnalyzeExpense.md)
+ [AnalyzeID](API_AnalyzeID.md)
+ [DetectDocumentText](API_DetectDocumentText.md)
+ [GetDocumentAnalysis](API_GetDocumentAnalysis.md)
+ [GetDocumentTextDetection](API_GetDocumentTextDetection.md)
+ [GetExpenseAnalysis](API_GetExpenseAnalysis.md)
+ [StartDocumentAnalysis](API_StartDocumentAnalysis.md)
+ [StartDocumentTextDetection](API_StartDocumentTextDetection.md)
+ [StartExpenseAnalysis](API_StartExpenseAnalysis.md)
# AnalyzeDocument
Analiza un documento de entrada en busca de relaciones entre elementos detectados.
Los tipos de información devuelta son los siguientes:
+ Datos de formulario (pares de clave-valor). La información relacionada se devuelve en dos[Block](API_Block.md)objetos, cada uno de tipo`KEY_VALUE_SET`: una LLAVE`Block`objeto y un VALOR`Block`objeto. Por ejemplo,*Name: Ana Silva Carolina*contiene una clave y un valor. *Name:*es la clave. *Ana Silva Carolina*es el valor.
+ Datos de celdas de tabla y tabla. UNA TABLA`Block`contiene información sobre una tabla detectada. UNA CELDA`Block`se devuelve para cada celda de una tabla.
+ Líneas y palabras de texto. UNA LÍNEA`Block`contiene uno o varios WORD`Block`objetos. Se devuelven todas las líneas y palabras detectadas en el documento (incluido el texto que no tiene relación con el valor de`FeatureTypes`).
Los elementos de selección, tales como casillas de verificación y botones de opción (botones de opción) se pueden detectar en los datos del formulario y en las tablas. UN ELEMENTO SELECTION\$1ELEMENT`Block`contiene información sobre un elemento de selección, incluido el estado de la selección.
Puede elegir qué tipo de análisis desea realizar especificando la`FeatureTypes`lista.
La salida se devuelve en una lista de`Block`objetos.
`AnalyzeDocument`es una operación síncrona. Para analizar documentos de forma asíncrona, utilice[StartDocumentAnalysis](API_StartDocumentAnalysis.md).
Para obtener más información, consulte[Análisis de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxis de la solicitud
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "string" ],
"HumanLoopConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"FlowDefinitionArn": "string",
"HumanLoopName": "string"
}
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [Document](#API_AnalyzeDocument_RequestSyntax) **
El documento de entrada como bytes codificados en base64 o un objeto Amazon S3. Si utiliza la CLI de AWS para llamar a las operaciones de Amazon Textract Texact, no puede pasar bytes de imagen. El documento debe ser una imagen en formato JPEG, PNG, PDF o TIFF.
Si utiliza un SDK de AWS para llamar a Amazon Textract, es posible que no tenga que codificar en base 64 bytes de imagen que se pasan mediante el`Bytes`.
Tipo: objeto [Document](API_Document.md)
Obligatorio: Sí
** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **
Lista de los tipos de análisis que se van a realizar. Agregue TABLES a la lista para devolver información sobre las tablas detectadas en el documento de entrada. Añada FORMULARIOS para devolver los datos del formulario detectados. Para realizar ambos tipos de análisis, agregue TABLES y FORMS a`FeatureTypes`. Todas las líneas y palabras detectadas en el documento se incluyen en la respuesta (incluido el texto que no está relacionado con el valor de`FeatureTypes`).
Type: Matriz de cadenas
Valores válidos:` TABLES | FORMS`
Obligatorio: Sí
** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **
Establece la configuración del flujo de trabajo humano en bucle para analizar documentos.
Tipo: objeto [HumanLoopConfig](API_HumanLoopConfig.md)
Obligatorio: No
## Sintaxis de la respuesta
```
{
"AnalyzeDocumentModelVersion": "string",
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"DocumentMetadata": {
"Pages": number
},
"HumanLoopActivationOutput": {
"HumanLoopActivationConditionsEvaluationResults": "string",
"HumanLoopActivationReasons": [ "string" ],
"HumanLoopArn": "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.
** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **
La versión del modelo que se utiliza para analizar el documento.
Type: Cadena
** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **
Los elementos detectados y analizados por`AnalyzeDocument`.
Type: Matriz de[Block](API_Block.md)objects
** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **
Metadatos sobre el documento analizado. Un ejemplo es el número de páginas.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **
Muestra los resultados de la evaluación humana en bucle.
Tipo: objeto [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)
## 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, consulte[Límites máximos de Amazon Textract](limits.md).
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
** HumanLoopQuotaExceededException **
Indica que ha superado la cantidad máxima de personas activas en los flujos de trabajo de bucle disponibles
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
** InvalidParameterException **
Un parámetro de entrada infringió una restricción. Por ejemplo, en operaciones sincrónicas, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 que se especifica en la solicitud. Para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 no puede procesar temporalmente la solicitud. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** UnsupportedDocumentException **
El formato del documento de entrada no se admite. 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument)
# AnalyzeExpense
`AnalyzeExpense`analiza sincrónicamente un documento de entrada para ver las relaciones financieras entre texto.
La información se devuelve como`ExpenseDocuments`y separados de la siguiente manera.
+ `LineItemGroups`- Conjunto de datos que contiene`LineItems`que almacenan información sobre las líneas de texto, como un artículo comprado y su precio en un recibo.
+ `SummaryFields`- Contiene toda la demás información de un recibo, como la información del encabezado o el nombre del proveedor.
## Sintaxis de la solicitud
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [Document](#API_AnalyzeExpense_RequestSyntax) **
El documento de entrada, ya sea en bytes o como objeto S3.
Puede transferir bytes de imágenes a una operación API Amazon Textract Texact utilizando la`Bytes`propiedad. Por ejemplo, usaría el`Bytes`para pasar un documento cargado desde un sistema de archivos local. Bytes de imagen pasados mediante el`Bytes`debe tener codificación base64. Es posible que el código no necesite codificar bytes de archivos de documentos si utiliza un SDK de AWS para llamar a las operaciones de la API de Amazon Textract Texact.
Puede transferir imágenes almacenadas en un bucket de S3 a una operación API Amazon Textract Texact utilizando el`S3Object`propiedad. Los documentos almacenados en un bucket de S3 no tienen por qué estar codificados en base64.
La región de AWS para el bucket de S3 que contiene el objeto S3 debe coincidir con la región de AWS que utiliza para las operaciones de Amazon Textract Texact.
Si utiliza la CLI de AWS para llamar a las operaciones de Amazon Textract Texact, no es posible transferir bytes de imágenes utilizando la propiedad Bytes. Debe cargar primero el documento en un bucket de Amazon S3 y, a continuación, llamar a la operación utilizando la propiedad S3Object.
Para que Amazon Textract Texact procese un objeto de S3, el usuario debe tener permiso para acceder al objeto de S3.
Tipo: objeto [Document](API_Document.md)
Obligatorio: Sí
## Sintaxis de la respuesta
```
{
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "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.
** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **
Información sobre el documento de entrada.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **
Los gastos detectados por Amazon Textract.
Type: Matriz de[ExpenseDocument](API_ExpenseDocument.md)objects
## 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, consulte[Límites máximos de Amazon Textract](limits.md).
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 operaciones asíncronas es de 500 MB para los archivos PDF.
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
** InvalidParameterException **
Un parámetro de entrada infringió una restricción. Por ejemplo, en operaciones sincrónicas, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 no puede obtener acceso al objeto de S3 que se especifica en la solicituda. para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 **
El formato del documento de entrada no es posible. 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense)
# AnalyzeID
Analiza los documentos de identidad para obtener información relevante. Esta información se extrae y se devuelve como`IdentityDocumentFields`, que registra tanto el campo normalizado como el valor del texto extraído. A diferencia de otras operaciones de Amazon Textract Texact,`AnalyzeID`no devuelve ningún dato de geometría.
## Sintaxis de la solicitud
```
{
"DocumentPages": [
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
]
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [DocumentPages](#API_AnalyzeID_RequestSyntax) **
El documento que se pasa a AnalyzeID.
Type: Matriz de[Document](API_Document.md)objects
Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 2 elementos.
Obligatorio: Sí
## Sintaxis de la respuesta
```
{
"AnalyzeIDModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"IdentityDocuments": [
{
"DocumentIndex": number,
"IdentityDocumentFields": [
{
"Type": {
"Confidence": number,
"NormalizedValue": {
"Value": "string",
"ValueType": "string"
},
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"NormalizedValue": {
"Value": "string",
"ValueType": "string"
},
"Text": "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.
** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **
Versión de la API AnalyzeIdentity que se utiliza para procesar documentos.
Type: Cadena
** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **
Información sobre el documento de entrada.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **
Lista de documentos procesados por AnalyzeID. Incluye un número que indica su lugar en la lista y la estructura de respuestas del documento.
Type: Matriz de[IdentityDocument](API_IdentityDocument.md)objects
## 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, consulte[Límites máximos de Amazon Textract](limits.md).
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
** InternalServerError **
Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** InvalidParameterException **
Un parámetro de entrada infringió una restricción. Por ejemplo, en operaciones sincrónicas, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 que se especificó en la solicitud. Para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 **
El formato del documento de entrada no es compatible. 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID)
# DetectDocumentText
Detecta el texto del documento de entrada. Amazon Textract Texact puede detectar líneas de texto y las palabras que componen una línea de texto. El documento de entrada debe ser una imagen en formato JPEG, PNG, PDF o TIFF.`DetectDocumentText`devuelve el texto detectado en una matriz de[Block](API_Block.md)objetos.
Cada página de documento tiene como asociado`Block`de tipo PAGE. Cada PÁGINA`Block`object es el principal de LINE`Block`objetos que representan las líneas del texto detectado en una página. UNA LÍNEA`Block`objeto es un padre para cada palabra que forma la línea. Las palabras están representadas por`Block`objetos de tipo WORD.
`DetectDocumentText`es una operación síncrona. Para analizar documentos de forma asíncrona, utilice[StartDocumentTextDetection](API_StartDocumentTextDetection.md).
Para obtener más información, consulte[Detección de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintaxis de la solicitud
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [Document](#API_DetectDocumentText_RequestSyntax) **
El documento de entrada como bytes codificados en base64 o un objeto Amazon S3. Si utiliza la CLI de AWS para llamar a las operaciones de Amazon Textract Texact, no puede pasar bytes de imagen. El documento debe ser una imagen en formato JPEG o PNG.
Si utiliza un SDK de AWS para llamar a Amazon Textract, es posible que no tenga que codificar en base 64 bytes de imagen que se pasan mediante el`Bytes`.
Tipo: objeto [Document](API_Document.md)
Obligatorio: Sí
## Sintaxis de la respuesta
```
{
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"DetectDocumentTextModelVersion": "string",
"DocumentMetadata": {
"Pages": number
}
}
```
## 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.
** [Blocks](#API_DetectDocumentText_ResponseSyntax) **
Una matriz de`Block`objetos que contienen el texto detectado en el documento.
Type: Matriz de[Block](API_Block.md)objects
** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **
Type: Cadena
** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **
Metadatos sobre el documento. Contiene el número de páginas detectadas en el documento.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
## 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, consulte[Límites máximos de Amazon Textract](limits.md).
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
** InternalServerError **
Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** InvalidParameterException **
Un parámetro de entrada infringió una restricción. Por ejemplo, en operaciones sincrónicas, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 no puede obtener acceso al objeto de S3 que se especificó en la solicituda. para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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 **
El formato del documento de entrada no se admite. 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText)
# GetDocumentAnalysis
Obtiene los resultados de una operación asíncrona de Amazon Textract Texact que analiza el texto de un documento.
Para iniciar un análisis de texto asíncrono, llama a[StartDocumentAnalysis](API_StartDocumentAnalysis.md), que devuelve un identificador de trabajo (`JobId`). Cuando finaliza la operación de análisis de texto, Amazon Textract Texact publica un estado de finalización en el tema de Amazon Simple Notification Service (Amazon SNS) registrado en la llamada inicial a`StartDocumentAnalysis`. Para obtener los resultados de la operación de detección de texto, compruebe primero que el valor de estado publicado en el tema de Amazon SNS es`SUCCEEDED`. Si es así, llame`GetDocumentAnalysis`y pasa el identificador de trabajo (`JobId`) desde la llamada inicial hasta`StartDocumentAnalysis`.
`GetDocumentAnalysis`devuelve una matriz de[Block](API_Block.md)objetos. Se devuelven los siguientes tipos de información:
+ Datos del formulario (pares de clave-valor). La información relacionada se devuelve en dos.[Block](API_Block.md)objetos, cada uno de tipo`KEY_VALUE_SET`: una LLAVE`Block`objeto y un VALOR`Block`objeto. Por ejemplo,*Name: Ana Silva Carolina*contiene una clave y un valor. *Name:*es la clave. *Ana Silva Carolina*es el valor.
+ Datos de celdas de tabla y tabla. UNA MESA`Block`contiene información sobre una tabla detectada. UNA CELDA`Block`se devuelve para cada celda de una tabla.
+ Líneas y palabras de texto. UNA LÍNEA`Block`un objeto contiene uno o varios WORD`Block`objetos. Se devuelven todas las líneas y palabras detectadas en el documento (incluido el texto que no tiene relación con el valor del`StartDocumentAnalysis` `FeatureTypes`parámetro de entrada).
Los elementos de selección, tales como casillas de verificación y botones de opción (botones de opción) se pueden detectar en los datos del formulario y en las tablas. A SELECTION\$1ELEMENT`Block`contiene información sobre un elemento de selección, incluido el estado de selección.
Usar`MaxResults`para limitar el número de bloques devueltos. Si hay más resultados de los especificados en`MaxResults`, el valor de`NextToken`en la respuesta de la operación contiene un token de paginación para obtener el siguiente conjunto de resultados. Para obtener la siguiente página de resultados, llame a`GetDocumentAnalysis`, y rellénela`NextToken`parámetro request con el valor de token que se devuelve de la llamada anterior a`GetDocumentAnalysis`.
Para obtener más información, consulte[Análisis de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxis de la solicitud
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **
Un identificador único del trabajo de detección de texto. La`JobId`se devuelve desde`StartDocumentAnalysis`. UNA`JobId`El 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-_]+$`
Obligatorio: Sí
** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **
El número máximo de resultados que devolver por llamada paginada. El valor mayor que puede especificar es 1,000. Si especifica un valor superior a 1 000, se devolverá un máximo de 1 000 resultados. El valor predeterminado es 1,000.
Type: Entero
Rango válido: Valor mínimo de 1.
Obligatorio: No
** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **
Si la respuesta anterior estaba incompleta (porque hay más bloques que recuperar), Amazon Texact devuelve un token de paginación en la respuesta. Puede utilizar este token de paginación para recuperar el siguiente conjunto de bloques.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
Obligatorio: No
## Sintaxis de la respuesta
```
{
"AnalyzeDocumentModelVersion": "string",
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"DocumentMetadata": {
"Pages": number
},
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"Warnings": [
{
"ErrorCode": "string",
"Pages": [ number ]
}
]
}
```
## 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.
** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **
Type: Cadena
** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **
Los resultados de la operación de análisis de texto.
Type: Matriz de[Block](API_Block.md)objects
** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **
Información sobre un documento que Amazon Textract procesó.`DocumentMetadata`se devuelve en cada página de respuestas paginadas de una operación de vídeo de Amazon Textract Texact.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **
El estado actual del trabajo de detección de texto.
Type: Cadena
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **
Si la respuesta se trunca, Amazon Textract devuelve este token. Puede utilizar este token en la solicitud subsiguiente para recuperar el siguiente conjunto de resultados de detección de texto.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **
Devuelve si el trabajo de detección no se ha podido completar. Contiene explicación de qué error se ha producido.
Type: Cadena
** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **
Lista de advertencias que se produjeron durante la operación de análisis de documentos.
Type: Matriz de[Warning](API_Warning.md)objects
## 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
** InternalServerError **
Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** InvalidJobIdException **
Se ha pasado un identificador de trabajo no válido a[GetDocumentAnalysis](#API_GetDocumentAnalysis)o para[GetDocumentAnalysis](#API_GetDocumentAnalysis).
Código de estado HTTP: 400
** 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 solicituda. para obtener más información,[Configurar el acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de estado HTTP: 400
** ProvisionedThroughputExceededException **
El número de solicitudes ha superado su límite de rendimiento. Si quieres aumentar este límite, ponte 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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis)
# GetDocumentTextDetection
Obtiene los resultados de una operación asíncrona de Amazon Texact que detecta texto de un documento. Amazon Textract Texact puede detectar líneas de texto y las palabras que componen una línea de texto.
Se inicia la detección de texto asíncrona llamando[StartDocumentTextDetection](API_StartDocumentTextDetection.md), que devuelve un identificador de trabajo (`JobId`). Cuando finaliza la operación de detección de texto, Amazon Textract Texact publica un estado de finalización en el tema de Amazon Simple Notification Service (Amazon SNS) registrado en la llamada inicial a`StartDocumentTextDetection`. Para obtener los resultados de la operación de detección de texto, compruebe primero que el valor de estado publicado en el tema de Amazon SNS es`SUCCEEDED`. Si es así, llame`GetDocumentTextDetection`y pasa el identificador de trabajo (`JobId`) desde la llamada inicial hasta`StartDocumentTextDetection`.
`GetDocumentTextDetection`devuelve una matriz de[Block](API_Block.md)objetos.
Cada página de documento tiene como asociado`Block`de tipo PAGE. Cada PÁGINA`Block`el objeto es el principal de LINE`Block`objetos que representan las líneas del texto detectado en una página. UNA LÍNEA`Block`objeto es un padre para cada palabra que forma la línea. Las palabras están representadas por`Block`objetos de tipo WORD.
Utilice el parámetro MaxResults para limitar el número de bloques devueltos. Si hay más resultados de los especificados en`MaxResults`, el valor de`NextToken`en la respuesta de la operación contiene un token de paginación para obtener el siguiente conjunto de resultados. Para obtener la siguiente página de resultados, llame`GetDocumentTextDetection`y rellénela`NextToken`parámetro request con el valor de token que se devuelve de la llamada anterior a`GetDocumentTextDetection`.
Para obtener más información, consulte[Detección de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintaxis de la solicitud
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **
Un identificador único para el trabajo de detección de texto. La`JobId`se devuelve desde`StartDocumentTextDetection`. UNA`JobId`El 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-_]+$`
Obligatorio: Sí
** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **
El número máximo de resultados que devolver por llamada paginada. El valor más grande que puede especificar es 1,000. Si especifica un valor superior a 1 000, se devolverá un máximo de 1 000 resultados. El valor predeterminado es 1,000.
Type: Entero
Rango válido: Valor mínimo de 1.
Obligatorio: No
** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **
Si la respuesta anterior estaba incompleta (porque hay más bloques que recuperar), Amazon Texact devuelve un token de paginación en la respuesta. Puede utilizar este token de paginación para recuperar el siguiente conjunto de bloques.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
Obligatorio: No
## Sintaxis de la respuesta
```
{
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"DetectDocumentTextModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"Warnings": [
{
"ErrorCode": "string",
"Pages": [ number ]
}
]
}
```
## 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.
** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **
Los resultados de la operación de detección de texto.
Type: Matrices de[Block](API_Block.md)objects
** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **
Type: Cadena
** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **
Información sobre un documento que Amazon Textract procesó.`DocumentMetadata`se devuelve en cada página de respuestas paginadas de una operación de vídeo de Amazon Textract Texact.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **
El estado actual del trabajo de detección de texto.
Type: Cadena
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **
Si la respuesta se trunca, Amazon Textract devuelve este token. Puede utilizar este token en la solicitud subsiguiente para recuperar el siguiente conjunto de resultados de detección de texto.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **
Devuelve si el trabajo de detección no se ha podido completar. Contiene explicación de qué error se ha producido.
Type: Cadena
** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **
Lista de advertencias que se produjeron durante la operación de detección de texto del documento.
Type: Matrices de[Warning](API_Warning.md)objects
## 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
** InternalServerError **
Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** InvalidJobIdException **
Se ha pasado un identificador de trabajo no válido a[GetDocumentAnalysis](API_GetDocumentAnalysis.md)o para[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Código de estado HTTP: 400
** 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de estado HTTP: 400
** ProvisionedThroughputExceededException **
El número de solicitudes ha superado su límite de rendimiento. Si quieres aumentar este límite, ponte 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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection)
# GetExpenseAnalysis
Obtiene los resultados de una operación asíncrona de Amazon Textract que analiza facturas y recibos. Amazon Textract encuentra la información de contacto, los artículos comprados y el nombre del proveedor, a partir de facturas y recibos de entrada.
Para iniciar un análisis asíncrono de factura/recibo llamando[StartExpenseAnalysis](API_StartExpenseAnalysis.md), que devuelve un identificador de trabajo (`JobId`). Una vez completado el análisis de factura/recepción, Amazon Textract publica el estado de realización en el tema de Amazon Simple Notification Service (Amazon SNS). Este tema debe registrarse en la llamada inicial a`StartExpenseAnalysis`. Para obtener los resultados de la operación de análisis de factura/recepción, en primer lugar, asegúrese de que el valor de estado publicado en el tema de Amazon SNS es`SUCCEEDED`. Si es así, llame`GetExpenseAnalysis`y pasa el identificador de trabajo (`JobId`) desde la llamada inicial hasta`StartExpenseAnalysis`.
Utilice el parámetro MaxResults para limitar el número de bloques devueltos. Si hay más resultados de los especificados en`MaxResults`, el valor de`NextToken`en la respuesta de operación contiene un token de paginación para obtener el siguiente conjunto de resultados. Para obtener la siguiente página de resultados, llame`GetExpenseAnalysis`, y rellénela`NextToken`parámetro request con el valor de token que se devuelve de la llamada anterior a`GetExpenseAnalysis`.
Para obtener más información, consulte[Análisis de facturas y recibos](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html).
## Sintaxis de la solicitud
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parámetros de solicitud
La solicitud acepta los siguientes datos en formato JSON.
** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **
Un identificador único para el trabajo de detección de texto. La`JobId`se devuelve desde`StartExpenseAnalysis`. UNA`JobId`El 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-_]+$`
Obligatorio: Sí
** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **
El número máximo de resultados que devolver por llamada paginada. El valor más grande que puede especificar es 20. Si especifica un valor superior a 20, se devolverá un máximo de 20 resultados. El valor predeterminado es 20.
Type: Entero
Rango válido: Valor mínimo de 1.
Obligatorio: No
** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **
Si la respuesta anterior estaba incompleta (porque hay más bloques que recuperar), Amazon Texact devuelve un token de paginación en la respuesta. Puede utilizar este token de paginación para recuperar el siguiente conjunto de bloques.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
Obligatorio: No
## Sintaxis de la respuesta
```
{
"AnalyzeExpenseModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
],
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"Warnings": [
{
"ErrorCode": "string",
"Pages": [ number ]
}
]
}
```
## 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.
** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **
La versión del modelo actual de AnalyzeExpense.
Type: Cadena
** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **
Información sobre un documento que Amazon Textract procesó.`DocumentMetadata`se devuelve en cada página de respuestas paginadas de una operación de Amazon Textract Texact.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **
Los gastos detectados por Amazon Textract.
Type: Matriz de[ExpenseDocument](API_ExpenseDocument.md)objects
** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **
El estado actual del trabajo de detección de texto.
Type: Cadena
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **
Si la respuesta se trunca, Amazon Textract devuelve este token. Puede utilizar este token en la solicitud subsiguiente para recuperar el siguiente conjunto de resultados de detección de texto.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `.*\S.*`
** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **
Devuelve si el trabajo de detección no se ha podido completar. Contiene explicación de qué error se ha producido.
Type: Cadena
** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **
Lista de advertencias que se produjeron durante la operación de detección de texto del documento.
Type: Matriz de[Warning](API_Warning.md)objects
## 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
** InternalServerError **
Amazon Textract ha tenido un problema de servicio. Pruebe la llamada de nuevo.
Código de estado HTTP: 500
** InvalidJobIdException **
Se ha pasado un identificador de trabajo no válido a[GetDocumentAnalysis](API_GetDocumentAnalysis.md)o para[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Código de estado HTTP: 400
** 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de estado HTTP: 400
** ProvisionedThroughputExceededException **
El número de solicitudes ha superado su límite de rendimiento. Si quieres aumentar este límite, ponte 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
## 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis)
# StartDocumentAnalysis
Inicia el análisis asíncrono de un documento de entrada para detectar las relaciones entre elementos detectados como pares clave-valor, tablas y elementos de selección.
`StartDocumentAnalysis`puede analizar el texto de documentos en formato JPEG, PNG, TIFF y PDF. Los documentos se almacenan en un bucket de Amazon S3. Usar[DocumentLocation](API_DocumentLocation.md)para especificar el nombre del bucket de y el nombre de archivo del documento.
`StartDocumentAnalysis`devuelve un identificador de trabajo (`JobId`) que utiliza para obtener los resultados de la operación. Cuando el análisis de texto se finalice, Amazon Textract Texact publica un estado de finalización en el tema de Amazon Simple Notification Service (Amazon SNS) que especifique en`NotificationChannel`. Para obtener los resultados de la operación de análisis de texto, compruebe primero que el valor de estado publicado en el tema de Amazon SNS es`SUCCEEDED`. Si es así, llame[GetDocumentAnalysis](API_GetDocumentAnalysis.md)y pasa el identificador de trabajo (`JobId`) desde la llamada inicial hasta`StartDocumentAnalysis`.
Para obtener más información, consulte[Análisis de texto en documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxis de la solicitud
```
{
"ClientRequestToken": "string",
"DocumentLocation": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "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](#API_StartDocumentAnalysis_RequestSyntax) **
El token idempotente que utiliza para identificar la solicitud de inicio. Si utilizas el mismo token con varios`StartDocumentAnalysis`solicitudes, lo mismo`JobId`se devuelve. Usar`ClientRequestToken`para evitar que el mismo trabajo se inicie accidentalmente más de una vez. Para obtener más información, consulte[Llamar a operaciones asíncronas de Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
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](#API_StartDocumentAnalysis_RequestSyntax) **
Ubicación del documento que se va a procesar.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
Obligatorio: Sí
** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **
Lista de los tipos de análisis que se van a realizar. Agregue TABLES a la lista para devolver información sobre las tablas detectadas en el documento de entrada. Añada FORMULARIOS para devolver los datos del formulario detectados. Para realizar ambos tipos de análisis, agregue TABLES y FORMS a`FeatureTypes`. Todas las líneas y palabras detectadas en el documento se incluyen en la respuesta (incluido el texto que no está relacionado con el valor de`FeatureTypes`).
Type: Matriz de cadenas
Valores válidos:` TABLES | FORMS`
Obligatorio: Sí
** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **
Identificador que especifique incluido en la notificación de finalización publicada en el tema de Amazon SNS. Por ejemplo, puede utilizar`JobTag`para 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](#API_StartDocumentAnalysis_RequestSyntax) **
La clave KMS utilizada para cifrar los resultados de 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](#API_StartDocumentAnalysis_RequestSyntax) **
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](API_NotificationChannel.md)
Obligatorio: No
** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **
Establece si la salida irá a un depósito definido por el cliente. De forma predeterminada, Amazon Textract Texact guardará los resultados internamente para acceder a ellos mediante la operación GetDocumentAnalysis.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
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](#API_StartDocumentAnalysis_ResponseSyntax) **
El identificador del trabajo de detección de texto en documentos. Usar`JobId`para identificar el trabajo en una llamada posterior a`GetDocumentAnalysis`. UNA`JobId`El valor es válido solo 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, consulte[Límites máximos de Amazon Textract](limits.md).
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 operaciones asíncronas es de 500 MB para los archivos PDF.
Código de estado HTTP: 400
** IdempotentParameterMismatchException **
UNA`ClientRequestToken`Se 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 no puede obtener acceso al objeto de S3 que se especifica en la solicituda. para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de estado HTTP: 400
** LimitExceededException **
Se ha superado un límite de servicio Amazon Textract. 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 Amazon Textract Texacte.
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)
# StartDocumentTextDetection
Comienza la detección asincrónica del texto de un documento. Amazon Textract Texact puede detectar líneas de texto y las palabras que componen una línea de texto.
`StartDocumentTextDetection`puede analizar el texto de documentos en formato JPEG, PNG, TIFF y PDF. Los documentos se almacenan en un bucket de Amazon S3. Usar[DocumentLocation](API_DocumentLocation.md)para especificar el nombre del bucket de y el nombre de archivo del documento.
`StartTextDetection`devuelve un identificador de trabajo (`JobId`) que utiliza para obtener los resultados de la operación. Una vez finalizada la detección de texto, Amazon Textract publica un estado de finalización en el tema Amazon Simple Notification Service (Amazon SNS) que especifique en`NotificationChannel`. Para obtener los resultados de la operación de detección de texto, compruebe primero que el valor de estado publicado en el tema de Amazon SNS es`SUCCEEDED`. Si es así, llame[GetDocumentTextDetection](API_GetDocumentTextDetection.md)y pasa el identificador de trabajo (`JobId`) desde la llamada inicial hasta`StartDocumentTextDetection`.
Para obtener más información, consulte[Detección de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## 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](#API_StartDocumentTextDetection_RequestSyntax) **
El token idempotente que se utiliza para identificar la solicitud de inicio. Si utilizas el mismo token con varios`StartDocumentTextDetection`solicitudes, lo mismo`JobId`se devuelve. Usar`ClientRequestToken`para evitar que el mismo trabajo se inicie accidentalmente más de una vez. Para obtener más información, consulte[Llamar a operaciones asíncronas de Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
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](#API_StartDocumentTextDetection_RequestSyntax) **
Ubicación del documento que se va a procesar.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
Obligatorio: Sí
** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **
Identificador que especifique que se incluye en la notificación de finalización publicada en el tema de Amazon SNS. Por ejemplo, puede utilizar`JobTag`para 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](#API_StartDocumentTextDetection_RequestSyntax) **
La clave KMS utilizada para cifrar los resultados de 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](#API_StartDocumentTextDetection_RequestSyntax) **
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](API_NotificationChannel.md)
Obligatorio: No
** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **
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 acceder a ellos con la operación GetDocumentTextDetection.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
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](#API_StartDocumentTextDetection_ResponseSyntax) **
Identificador del trabajo de detección de texto del documento. Usar`JobId`para identificar el trabajo en una llamada posterior a`GetDocumentTextDetection`. UNA`JobId`El 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, consulte[Límites máximos de Amazon Textract](limits.md).
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 **
UNA`ClientRequestToken`se 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 que se especifica en la solicitud. Para obtener más información,[Configuración del acceso a Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de estado HTTP: 400
** LimitExceededException **
Se ha superado un límite de servicio Amazon Textract. Por ejemplo, si inicia demasiados trabajos asíncronos simultáneamente, llama para iniciar operaciones (`StartDocumentTextDetection`, por ejemplo) produce una excepción de 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 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection)
# 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.
`StartExpenseAnalysis`puede analizar el texto de documentos en formato JPEG, PNG y PDF. Los documentos deben almacenarse en un bucket de Amazon S3. Usar[DocumentLocation](API_DocumentLocation.md)para especificar el nombre del bucket de S3 y el nombre del documento de ese bucket.
`StartExpenseAnalysis`devuelve un identificador de trabajo (`JobId`) que proporcionarás a`GetExpenseAnalysis`para 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 al`NotificationChannel`. 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 sea`SUCCEEDED`. Si es así, llame[GetExpenseAnalysis](API_GetExpenseAnalysis.md)y pasa el identificador de trabajo (`JobId`) que se devolvió mediante tu llamada a`StartExpenseAnalysis`.
Para obtener más información, consulte[Análisis de facturas y recibos](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html).
## 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](#API_StartExpenseAnalysis_RequestSyntax) **
El token idempotente que se utiliza para identificar la solicitud de inicio. Si utilizas el mismo token con varios`StartDocumentTextDetection`solicitudes, lo mismo`JobId`se devuelve. Usar`ClientRequestToken`para evitar que el mismo trabajo se inicie accidentalmente más de una vez. Para obtener más información, consulte[Llamar a operaciones asíncronas de Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)
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](#API_StartExpenseAnalysis_RequestSyntax) **
Ubicación del documento que se va a procesar.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
: obligatorio Sí
** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **
Identificador que especifique que se incluye en la notificación de finalización publicada en el tema de Amazon SNS. Por ejemplo, puede utilizar`JobTag`para 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](#API_StartExpenseAnalysis_RequestSyntax) **
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](#API_StartExpenseAnalysis_RequestSyntax) **
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](API_NotificationChannel.md)
: obligatorio No
** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **
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 ellos`GetExpenseAnalysis`.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
: 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](#API_StartExpenseAnalysis_ResponseSyntax) **
Un identificador único del trabajo de detección de texto. La`JobId`se devuelve desde`StartExpenseAnalysis`. UNA`JobId`El 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, consulte[Límites máximos de Amazon Textract](limits.md).
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 **
UNA`ClientRequestToken`Se 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, un`InvalidParameterException`se produce cuando ninguno de los`S3Object`o`Bytes`los valores se proporcionan en el`Document`pará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 S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obtener información sobre la resolución de problemas, consulte[Solución de problemas de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK de AWS para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK para Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK de AWS para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK de AWS para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)