As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Ações
As ações a seguir são compatíveis:
+ [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
Analisa um documento de entrada para os relacionamentos entre itens detectados em um documento
Os tipos de informações retornadas são os seguintes:
+ Dados do formulário (pares de chave-valor). As informações relacionadas são retornadas em dois[Block](API_Block.md)objetos, cada um dos tipos`KEY_VALUE_SET`: uma CHAVE`Block`objeto e um VALOR`Block`objeto. Por exemplo,*Name (Nome): Ana Silva Carolina*contém uma chave e um valor. *Name (Nome):*é a chave. *Ana Silva Carolina*É o valor de.
+ Dados de células de tabela e tabela. UMA TABELA`Block`objeto contém informações sobre uma tabela detectada. UMA CÉLULA`Block`objeto é retornado para cada célula em uma tabela.
+ Linhas e palavras de texto. UMA LINHA`Block`O objeto contém um ou mais WORD`Block`objetos. Todas as linhas e palavras detectadas no documento são retornadas (incluindo texto que não tem relação com o valor de`FeatureTypes`).
Elementos de seleção, como caixas de seleção e botões de opção (botões de opção), podem ser detectados em dados de formulário e em tabelas. UM SELECTION\$1ELEMENT`Block`objeto contém informações sobre um elemento de seleção, incluindo o status da seleção.
Você pode escolher qual tipo de análise executar especificando o`FeatureTypes`Lista.
A saída é retornada em uma lista de`Block`objetos.
`AnalyzeDocument`É uma operação síncrona. Para analisar documentos de forma assíncrona, use[StartDocumentAnalysis](API_StartDocumentAnalysis.md).
Para obter mais informações, consulte[Análise de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxe da solicitação
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "string" ],
"HumanLoopConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"FlowDefinitionArn": "string",
"HumanLoopName": "string"
}
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Document](#API_AnalyzeDocument_RequestSyntax) **
O documento de entrada como bytes codificados em base64 ou um objeto do Amazon S3. Se você usar a AWS CLI para chamar as operações do Amazon Textract, não poderá passar bytes de imagem. O documento deve ser uma imagem no formato JPEG, PNG, PDF ou TIFF.
Se você estiver usando um AWS SDK para chamar o Amazon Textract, talvez não seja necessário codificar bytes de imagem que são passados usando o`Bytes`campo.
Tipo: objeto [Document](API_Document.md)
: obrigatório Sim
** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **
Uma lista dos tipos de análise a serem executadas. Adicione TABLES à lista para retornar informações sobre as tabelas detectadas no documento de entrada. Adicione FORMS para retornar dados de formulário detectados. Para executar os dois tipos de análise, adicione TABLES e FORMS ao`FeatureTypes`. Todas as linhas e palavras detectadas no documento estão incluídas na resposta (incluindo texto que não está relacionado ao valor de`FeatureTypes`).
Type: Matriz de strings
Valores válidos:` TABLES | FORMS`
: obrigatório Sim
** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **
Define a configuração para o humano no fluxo de trabalho de loop para analisar documentos.
Tipo: objeto [HumanLoopConfig](API_HumanLoopConfig.md)
: obrigatório Não
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **
A versão do modelo usado para analisar o documento.
Type: String
** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **
Os itens que são detectados e analisados por`AnalyzeDocument`.
Type: Matriz de[Block](API_Block.md)objetos
** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **
Metadados sobre o documento analisado. Um exemplo é o número de páginas.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **
Mostra os resultados do humano na avaliação de loop.
Tipo: objeto [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** HumanLoopQuotaExceededException **
Indica que você excedeu o número máximo de humanos ativos nos fluxos de trabalho de loop disponíveis
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é compatível. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument)
# AnalyzeExpense
`AnalyzeExpense`analisa de forma síncrona um documento de entrada para relacionamentos financeiramente relacionados entre o texto.
As informações são retornadas como`ExpenseDocuments`e separado da seguinte forma.
+ `LineItemGroups`- Um conjunto de dados contendo`LineItems`que armazenam informações sobre as linhas de texto, como um item comprado e seu preço em um recibo.
+ `SummaryFields`- Contém todas as outras informações de um recibo, como informações de cabeçalho ou o nome dos fornecedores.
## Sintaxe da solicitação
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Document](#API_AnalyzeExpense_RequestSyntax) **
O documento de entrada, seja como bytes ou como um objeto S3.
Passe bytes de imagem para a operação de uma API Amazon Textract usando a`Bytes`propriedade. Por exemplo, você usaria a`Bytes`propriedade para passar um documento carregado de um sistema de arquivos local. Bytes de imagem passados usando o`Bytes`A propriedade deve ser codificada em base64. Talvez seu código não precise codificar bytes de arquivos de documentos se você estiver usando um AWS SDK para chamar as operações da API do Amazon Textract.
Passe imagens armazenadas em um bucket do S3 para uma operação de API Amazon Textract usando a`S3Object`propriedade. Os documentos armazenados em um bucket do S3 não precisam ser codificados em base64.
A Região da AWS do bucket do S3 que contém o objeto S3 deve corresponder à região da AWS que você usa para operações Amazon Textract.
Se você usar a AWS CLI para chamar operações do Amazon Textract, não haverá suporte para a passagem dos bytes da imagem da propriedade. Você deve primeiramente carregar o documento em um bucket do Amazon S3 e, em seguida, chamar a operação usando a propriedade S3Object.
Para que o Amazon Textract processe um objeto do S3, o usuário deve ter permissão para acessar o objeto do S3.
Tipo: objeto [Document](API_Document.md)
: obrigatório Sim
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **
Informações sobre o documento de entrada.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **
As despesas detectadas pelo Amazon Textract.
Type: Matriz de[ExpenseDocument](API_ExpenseDocument.md)objetos
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** InternalServerError **
Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos no`Document`parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é oferecido o suporte. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense)
# AnalyzeID
Analisa documentos de identidade para obter informações relevantes. Essas informações são extraídas e retornadas como`IdentityDocumentFields`, que registra o campo normalizado e o valor do texto extraído.Ao contrário de outras operações Amazon Textract,`AnalyzeID`não retorna nenhum dado de geometria.
## Sintaxe da solicitação
```
{
"DocumentPages": [
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
]
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [DocumentPages](#API_AnalyzeID_RequestSyntax) **
O documento que está sendo passado para o AnalyzeID.
Type: Matriz de[Document](API_Document.md)objetos
Membros da matriz: Número mínimo de 1 item. Número máximo de 2 itens.
Obrigatório: Sim
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **
A versão da API AnalyzeIdentity que está sendo usada para processar documentos.
Type: String
** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **
Informações sobre o documento de entrada.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **
A lista de documentos processados pelo AnalyzeID. Inclui um número que denota seu lugar na lista e a estrutura de resposta do documento.
Type: Matriz de[IdentityDocument](API_IdentityDocument.md)objetos
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos no`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract está indisponível para acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é compatível. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID)
# DetectDocumentText
Detecta texto no documento de entrada. O Amazon Textract pode detectar linhas de texto e as palavras que compõem uma linha de texto. O documento de entrada deve ser uma imagem no formato JPEG, PNG, PDF ou TIFF.`DetectDocumentText`retorna o texto detectado em uma matriz de[Block](API_Block.md)objetos.
Cada página do documento tem como associado`Block`do tipo PAGE. Cada PÁGINA`Block`object é o pai de LINE`Block`objetos que representam as linhas do texto detectado em uma página. UMA LINHA`Block`object é um pai para cada palavra que compõe a linha. As palavras são representadas por`Block`objetos do tipo WORD.
`DetectDocumentText`É uma operação síncrona. Para analisar documentos de forma assíncrona, use[StartDocumentTextDetection](API_StartDocumentTextDetection.md).
Para obter mais informações, consulte[Detecção de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintaxe da solicitação
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Document](#API_DetectDocumentText_RequestSyntax) **
O documento de entrada como bytes codificados em base64 ou um objeto do Amazon S3. Se você usar a AWS CLI para chamar as operações do Amazon Textract, não poderá passar bytes de imagem. O documento deve ser uma imagem em formato JPEG ou PNG.
Se você estiver usando um AWS SDK para chamar o Amazon Textract, talvez não seja necessário codificar bytes de imagem que são passados usando o`Bytes`campo.
Tipo: objeto [Document](API_Document.md)
Obrigatório: Sim
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [Blocks](#API_DetectDocumentText_ResponseSyntax) **
Uma matriz de`Block`objetos que contêm o texto detectado no documento.
Type: Matriz de[Block](API_Block.md)objetos
** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **
Type: String
** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **
Metadados sobre o documento. Ele contém o número de páginas detectadas no documento.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract está indisponível para acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não tem suporte. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText)
# GetDocumentAnalysis
Obtém os resultados de uma operação assíncrona do Amazon Textract que analisa o texto em um documento.
Você inicia a análise de texto assíncrona chamando[StartDocumentAnalysis](API_StartDocumentAnalysis.md), que retorna um identificador de trabalho (`JobId`). Quando a operação de análise de texto termina, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) registrado na chamada inicial para`StartDocumentAnalysis`. Para obter os resultados da operação de detecção de texto, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue`GetDocumentAnalysis`e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartDocumentAnalysis`.
`GetDocumentAnalysis`retorna uma matriz de[Block](API_Block.md)objetos. Os seguintes tipos de informações são retornados:
+ Dados de formulário (pares de chave-valor). As informações relacionadas são retornadas em dois[Block](API_Block.md)objetos, cada um dos tipos`KEY_VALUE_SET`: uma CHAVE`Block`objeto e um VALOR`Block`objeto. Por exemplo,*Name (Nome): Ana Silva Carolina*contém uma chave e um valor. *Name (Nome):*é a chave. *Ana Silva Carolina*É o valor.
+ Dados de células de tabela e tabela. UMA TABELA`Block`objeto contém informações sobre uma tabela detectada. UMA CÉLULA`Block`objeto é retornado para cada célula em uma tabela.
+ Linhas e palavras de texto. UMA LINHA`Block`O objeto contém um ou mais WORD`Block`objetos. Todas as linhas e palavras detectadas no documento são retornadas (incluindo texto que não tem relação com o valor do`StartDocumentAnalysis` `FeatureTypes`parâmetro de entrada).
Elementos de seleção, como caixas de seleção e botões de opção (botões de opção), podem ser detectados em dados de formulário e em tabelas. UM SELECTION\$1ELEMENT`Block`objeto contém informações sobre um elemento de seleção, incluindo o status da seleção.
Usar a`MaxResults`Parâmetro para limitar o número de blocos retornados. Se houver mais resultados do que o especificado em`MaxResults`, o valor de`NextToken`Na resposta da operação contém um token de paginação para obter o próximo conjunto de resultados. Para obter a próxima página de resultados, ligue para`GetDocumentAnalysis`e preencha o`NextToken`parâmetro request com o valor do token retornado da chamada anterior para`GetDocumentAnalysis`.
Para obter mais informações, consulte[Análise de texto do documento](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxe da solicitação
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **
Um identificador exclusivo para o trabalho de detecção de texto. O`JobId`é retornado de`StartDocumentAnalysis`. UMA`JobId`O valor só é válido por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
Obrigatório Sim
** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **
O número máximo de resultados a serem retornados por chamada paginada. O maior valor que você pode especificar é 1.000. Se precisar um valor maior que 1.000, um máximo de 1.000 resultados será retornado. O valor padrão é 1,000.
Type: Inteiro
Intervalo válido: Valor mínimo de 1.
Obrigatório Não
** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **
Se a resposta anterior estiver incompleta (porque há mais blocos para recuperar), o Amazon Textract retornará um token de paginação na resposta. Você pode usar esse token de paginação para recuperar o próximo conjunto de blocos.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
Obrigatório Não
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **
Type: String
** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **
Os resultados da operação de análise de texto.
Type: Matriz de[Block](API_Block.md)objetos
** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **
Informações sobre um documento que o Amazon Textract processou.`DocumentMetadata`é retornado em todas as páginas de respostas paginadas de uma operação de vídeo do Amazon Textract.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **
O status atual do trabalho de detecção de texto.
Type: String
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **
Se a resposta for truncada, o Amazon Textract retornará esse token. Você pode usar esse token na solicitação subsequente para recuperar o próximo conjunto de resultados de detecção de texto.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **
Retorna se o trabalho de detecção não puder ser concluído. Contém explicação para qual erro ocorreu.
Type: String
** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **
Uma lista de avisos ocorridos durante a operação de análise de documentos.
Type: Matriz de[Warning](API_Warning.md)objetos
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidJobIdException **
Um identificador de trabalho inválido foi passado para[GetDocumentAnalysis](#API_GetDocumentAnalysis)ou para[GetDocumentAnalysis](#API_GetDocumentAnalysis).
Código de status HTTP: 400
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configurar o acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis)
# GetDocumentTextDetection
Obtém os resultados de uma operação assíncrona do Amazon Textract que detecta texto em um documento. O Amazon Textract pode detectar linhas de texto e as palavras que compõem uma linha de texto.
Você inicia a detecção de texto assíncrona chamando[StartDocumentTextDetection](API_StartDocumentTextDetection.md), que retorna um identificador de trabalho (`JobId`). Quando a operação de detecção de texto for concluída, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) registrado na chamada inicial para`StartDocumentTextDetection`. Para obter os resultados da operação de detecção de texto, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue`GetDocumentTextDetection`e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartDocumentTextDetection`.
`GetDocumentTextDetection`retorna uma matriz de[Block](API_Block.md)objetos.
Cada página do documento tem como associado`Block`do tipo PAGE. Cada PÁGINA`Block`object é o pai de LINE`Block`objetos que representam as linhas do texto detectado em uma página. UMA LINHA`Block`object é um pai para cada palavra que compõe a linha. As palavras são representadas por`Block`objetos do tipo WORD.
Use o parâmetro MaxResults para limitar o número de blocos retornados. Se houver mais resultados do que o especificado em`MaxResults`, o valor de`NextToken`A resposta da operação contém um token de paginação para obter o próximo conjunto de resultados. Para obter a próxima página de resultados, ligue`GetDocumentTextDetection`e preencha o`NextToken`parâmetro request com o valor do token retornado da chamada anterior para`GetDocumentTextDetection`.
Para obter mais informações, consulte[Detecção de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintaxe da solicitação
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **
Um identificador exclusivo para a tarefa de detecção de texto. O`JobId`é retornado de`StartDocumentTextDetection`. UMA`JobId`O valor só é válido por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
Obrigatório: Sim
** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **
O número máximo de resultados a serem retornados por chamada paginada. O maior valor que você pode especificar é 1.000. Se você especificar um valor maior que 1.000, um máximo de 1.000 resultados será retornado. O valor padrão é 1,000.
Type: Inteiro
Intervalo válido: Valor mínimo de 1.
Obrigatório: Não
** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **
Se a resposta anterior estiver incompleta (porque há mais blocos para recuperar), o Amazon Textract retornará um token de paginação na resposta. Você pode usar esse token de paginação para recuperação do próximo conjunto de blocos.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
Obrigatório: Não
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **
Os resultados da operação de detecção de texto.
Type: Matriz de[Block](API_Block.md)objetos
** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **
Type: String
** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **
Informações sobre um documento que o Amazon Textract processou.`DocumentMetadata`é retornado em todas as páginas de respostas paginadas de uma operação de vídeo do Amazon Textract.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **
O status atual da tarefa de detecção de texto.
Type: String
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **
Se a resposta for truncada, o Amazon Textract retornará esse token. Você pode usar esse token na solicitação subsequente para recuperação do próximo conjunto de resultados de detecção de texto.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **
O retorna se o trabalho de detecção não puder ser concluído. Contém explicação para qual erro ocorreu.
Type: String
** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **
Uma lista de avisos ocorridos durante a operação de detecção de texto do documento.
Type: Matriz de[Warning](API_Warning.md)objetos
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidJobIdException **
Um identificador de trabalho inválido foi passado para[GetDocumentAnalysis](API_GetDocumentAnalysis.md)ou para[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Código de status HTTP: 400
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos no`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se quiser aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection)
# GetExpenseAnalysis
Obtém os resultados de uma operação assíncrona do Amazon Textract que analisa faturas e recibos. Amazon Textract encontra informações de contato, itens comprados e nome do fornecedor, a partir de faturas e recibos de entrada.
Você inicia a análise assíncrona de fatura/recebimento ligando[StartExpenseAnalysis](API_StartExpenseAnalysis.md), que retorna um identificador de trabalho (`JobId`). Após a conclusão da análise de fatura/recebimento, o Amazon Textract publica o status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS). Este tópico deve ser registrado na chamada inicial para`StartExpenseAnalysis`. Para obter os resultados da operação de análise de fatura/recebimento, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue para`GetExpenseAnalysis`e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartExpenseAnalysis`.
Use o parâmetro MaxResults para limitar o número de blocos que são retornados. Se houver mais resultados do que o especificado em`MaxResults`, o valor de`NextToken`Na resposta da operação contém um token de paginação para obter o próximo conjunto de resultados. Para obter a próxima página de resultados, ligue para`GetExpenseAnalysis`e preencher as UOs`NextToken`parâmetro request com o valor do token retornado da chamada anterior para`GetExpenseAnalysis`.
Para obter mais informações, consulte[Analisando faturas e recibos](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html).
## Sintaxe da solicitação
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros de solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **
Um identificador exclusivo para o trabalho de detecção de texto. O`JobId`é retornado do`StartExpenseAnalysis`. UMA`JobId`O valor é válido apenas por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
: obrigatório Sim
** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **
O número máximo de resultados a serem retornados por chamada paginada. O maior valor que você pode especificar é 20. Se você especificar um valor maior que 20, um máximo de 20 resultados será retornado. O valor padrão é 20.
Type: Inteiro
Intervalo válido: Valor mínimo de 1.
: obrigatório Não
** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **
Se a resposta anterior estiver incompleta (porque há mais blocos para recuperar), o Amazon Textract retornará um token de paginação na resposta. Você pode usar esse token de paginação para recuperar o próximo conjunto de blocos.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
: obrigatório Não
## Sintaxe da resposta
```
{
"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 resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **
A versão atual do modelo do AnalyzeExpense.
Type: String
** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **
Informações sobre um documento que o Amazon Textract processou.`DocumentMetadata`é retornado em todas as páginas de respostas paginadas de uma operação Amazon Textract.
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **
As despesas detectadas pelo Amazon Textract.
Type: Matriz de[ExpenseDocument](API_ExpenseDocument.md)objetos
** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **
O status atual do trabalho de detecção de texto.
Type: String
Valores válidos:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **
Se a resposta for truncada, o Amazon Textract retornará esse token. Você pode usar esse token na solicitação subsequente para recuperar o próximo conjunto de resultados de detecção de texto.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 255.
Padrão: `.*\S.*`
** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **
Retorna se o trabalho de detecção não puder ser concluído. Contém explicação para qual erro ocorreu.
Type: String
** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **
Uma lista de avisos ocorridos durante a operação de detecção de texto do documento.
Type: Matriz de[Warning](API_Warning.md)objetos
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidJobIdException **
Um identificador de trabalho inválido foi passado para[GetDocumentAnalysis](API_GetDocumentAnalysis.md)ou para[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
Código de status HTTP: 400
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos no`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se quiser aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis)
# StartDocumentAnalysis
Inicia a análise assíncrona de um documento de entrada para pesquisar relacionamentos entre itens detectados, como pares de chave-valor, tabelas e elementos de seleção.
`StartDocumentAnalysis`pode analisar texto em documentos que estão nos formatos JPEG, PNG, TIFF e PDF. Os documentos são armazenados em um bucket do Amazon S3. Usar o[DocumentLocation](API_DocumentLocation.md)Para especificar o nome do bucket do e o nome do arquivo do documento.
`StartDocumentAnalysis`retorna um identificador de trabalho (`JobId`) que você usa para obter os resultados da operação. Quando a análise de texto for concluída, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) especificado no`NotificationChannel`. Para obter os resultados da operação de análise de texto, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue[GetDocumentAnalysis](API_GetDocumentAnalysis.md)e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartDocumentAnalysis`.
Para obter mais informações, consulte[Análise de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Sintaxe da solicitação
```
{
"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 solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **
O token idempotente que você usa para identificar a solicitação inicial. Se você usar o mesmo token com vários`StartDocumentAnalysis`solicitações, o mesmo`JobId`O retornado. Usar o`ClientRequestToken`para evitar que o mesmo trabalho seja iniciado acidentalmente mais de uma vez. Para obter mais informações, consulte[Chamando operações assíncronas do Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
Obrigatório: Não
** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) **
A localização do documento a ser processado.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
Obrigatório: Sim
** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **
Uma lista dos tipos de análise a serem executadas. Adicione TABLES à lista para retornar informações sobre as tabelas detectadas no documento de entrada. Adicione FORMS para retornar dados de formulário detectados. Para executar os dois tipos de análise, adicione TABLES e FORMS ao`FeatureTypes`. Todas as linhas e palavras detectadas no documento estão incluídas na resposta (incluindo texto que não está relacionado ao valor de`FeatureTypes`).
Type: Matriz de strings
Valores válidos:` TABLES | FORMS`
Obrigatório: Sim
** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **
Um identificador que você especifica que está incluído na notificação de conclusão publicada no tópico do Amazon SNS. Por exemplo, você pode usar`JobTag`para identificar o tipo de documento ao qual a notificação de conclusão corresponde (como um formulário fiscal ou um recibo).
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `[a-zA-Z0-9_.\-:]+`
Obrigatório: Não
** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) **
A chave do KMS usada para criptografar os resultados de inferência. Isso pode estar no formato Key ID ou Key Alias. Quando uma chave KMS é fornecida, a chave KMS será usada para criptografia do lado do servidor dos objetos no bucket do cliente. Quando esse parâmetro não estiver habilitado, o resultado será criptografado no lado do servidor, usando o SSE-S3.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`
Obrigatório: Não
** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) **
O tópico ARN do Amazon SNS no qual você deseja que o Amazon Textract publique o status de conclusão da operação.
Tipo: objeto [NotificationChannel](API_NotificationChannel.md)
Obrigatório: Não
** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **
Define se a saída irá para um intervalo definido pelo cliente. Por padrão, o Amazon Textract salvará os resultados internamente para serem acessados pela operação GetDocumentAnalysis.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
Obrigatório: Não
## Sintaxe da resposta
```
{
"JobId": "string"
}
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) **
O identificador do trabalho de detecção de texto do documento. Usar o`JobId`para identificar o trabalho em uma chamada subsequente para`GetDocumentAnalysis`. UMA`JobId`O valor só é válido por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** IdempotentParameterMismatchException **
UMA`ClientRequestToken`O parâmetro de entrada foi reutilizado com uma operação, mas pelo menos um dos outros parâmetros de entrada é diferente da chamada anterior para a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** LimitExceededException **
Um limite do serviço do Amazon Textract foi excedido. Por exemplo, se você iniciar muitos trabalhos assíncronos simultaneamente, chamadas para iniciar operações (`StartDocumentTextDetection`, por exemplo) gera uma exceção LimitExceededException (código de status HTTP: 400) até que o número de trabalhos simultâneos fique abaixo do limite de serviço do Amazon Textract.
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é suportado. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)
# StartDocumentTextDetection
Inicia a detecção assíncrona de texto em um documento. O Amazon Textract pode detectar linhas de texto e as palavras que compõem uma linha de texto.
`StartDocumentTextDetection`pode analisar texto em documentos que estão nos formatos JPEG, PNG, TIFF e PDF. Os documentos são armazenados em um bucket do Amazon S3. Usar o[DocumentLocation](API_DocumentLocation.md)Para especificar o nome do bucket do e o nome do arquivo do documento.
`StartTextDetection`retorna um identificador de trabalho (`JobId`) que você usa para obter os resultados da operação. Quando a detecção de texto for concluída, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) especificado no`NotificationChannel`. Para obter os resultados da operação de detecção de texto, primeiro verifique se o valor de status publicado no tópico do Amazon SNS é`SUCCEEDED`. Em caso afirmativo, ligue[GetDocumentTextDetection](API_GetDocumentTextDetection.md)e passar o identificador de trabalho (`JobId`) da chamada inicial para`StartDocumentTextDetection`.
Para obter mais informações, consulte[Detecção de texto de documentos](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Sintaxe da solicitação
```
{
"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 solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **
O token idempotente usado para identificar a solicitação inicial. Se você usar o mesmo token com vários`StartDocumentTextDetection`solicitações, o mesmo`JobId`é retornado. Usar o`ClientRequestToken`para evitar que o mesmo trabalho seja iniciado acidentalmente mais de uma vez. Para obter mais informações, consulte[Chamando operações assíncronas do Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
: obrigatório Não
** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) **
A localização do documento a ser processado.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
: obrigatório Sim
** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **
Um identificador que você especifica que está incluído na notificação de conclusão publicada no tópico do Amazon SNS. Por exemplo, você pode usar`JobTag`para identificar o tipo de documento ao qual a notificação de conclusão corresponde (como um formulário fiscal ou um recibo).
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `[a-zA-Z0-9_.\-:]+`
: obrigatório Não
** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) **
A chave do KMS usada para criptografar os resultados de inferência. Isso pode estar no formato Key ID ou Key Alias. Quando uma chave KMS é fornecida, a chave KMS será usada para criptografia do lado do servidor dos objetos no bucket do cliente. Quando esse parâmetro não estiver habilitado, o resultado será criptografado no lado do servidor, usando o SSE-S3.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`
: obrigatório Não
** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) **
O tópico ARN do Amazon SNS no qual você deseja que o Amazon Textract publique o status de conclusão da operação.
Tipo: objeto [NotificationChannel](API_NotificationChannel.md)
: obrigatório Não
** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **
Define se a saída irá para um intervalo definido pelo cliente. Por padrão, o Amazon Textract salvará os resultados internamente para serem acessados com a operação GetDocumentTextDetection.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
: obrigatório Não
## Sintaxe da resposta
```
{
"JobId": "string"
}
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) **
O identificador da tarefa de detecção de texto para o documento. Usar o`JobId`para identificar o trabalho em uma chamada subsequente para`GetDocumentTextDetection`. UMA`JobId`O valor só é válido por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** IdempotentParameterMismatchException **
UMA`ClientRequestToken`O parâmetro de entrada foi reutilizado com uma operação, mas pelo menos um dos outros parâmetros de entrada é diferente da chamada anterior para a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** LimitExceededException **
Um limite de serviço do Amazon Textract foi excedido. Por exemplo, se você iniciar muitos trabalhos assíncronos simultaneamente, chamadas para iniciar operações (`StartDocumentTextDetection`, por exemplo) gera uma exceção LimitExceededException (código de status HTTP: 400) até que o número de trabalhos simultâneos fique abaixo do limite de serviço Amazon Textract.
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é suportado. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection)
# StartExpenseAnalysis
Inicia a análise assíncrona de faturas ou recibos de dados como informações de contato, itens comprados e nomes de fornecedores.
`StartExpenseAnalysis`pode analisar texto em documentos que estão nos formatos JPEG, PNG e PDF. Os documentos devem ser armazenados em um bucket do Amazon S3. Usar a[DocumentLocation](API_DocumentLocation.md)Um parâmetro para especificar o nome do bucket do S3 e o nome do documento nesse bucket.
`StartExpenseAnalysis`retorna um identificador de trabalho (`JobId`) que você fornecerá`GetExpenseAnalysis`Para recuperar os resultados da operação. Quando a análise das faturas/recibos de entrada for concluída, o Amazon Textract publica um status de conclusão no tópico do Amazon Simple Notification Service (Amazon SNS) que você fornece para o`NotificationChannel`. Para obter os resultados da operação de análise de recibos e fatura, certifique-se de que o valor de status publicado no tópico do Amazon SNS seja`SUCCEEDED`. Em caso afirmativo, ligue[GetExpenseAnalysis](API_GetExpenseAnalysis.md)e passar o identificador de trabalho (`JobId`) que foi devolvido por sua chamada para`StartExpenseAnalysis`.
Para obter mais informações, consulte[Analisando faturas e recibos](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html).
## Sintaxe da solicitação
```
{
"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 solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **
O token idempotente usado para identificar a solicitação inicial. Se você usar o mesmo token com vários`StartDocumentTextDetection`solicitações, o mesmo`JobId`é retornado. Usar o`ClientRequestToken`para evitar que o mesmo trabalho seja iniciado acidentalmente mais de uma vez. Para obter mais informações, consulte[Chamando operações assíncronas do Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
: obrigatório Não
** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) **
A localização do documento a ser processado.
Tipo: objeto [DocumentLocation](API_DocumentLocation.md)
: obrigatório Sim
** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **
Um identificador que você especifica que está incluído na notificação de conclusão publicada no tópico do Amazon SNS. Por exemplo, você pode usar`JobTag`para identificar o tipo de documento ao qual a notificação de conclusão corresponde (como um formulário fiscal ou um recibo).
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `[a-zA-Z0-9_.\-:]+`
: obrigatório Não
** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) **
A chave do KMS usada para criptografar os resultados da inferência. Isso pode estar no formato Key ID ou Key Alias. Quando uma chave KMS é fornecida, a chave KMS será usada para criptografia do lado do servidor dos objetos no bucket do cliente. Quando esse parâmetro não estiver habilitado, o resultado será criptografado no lado do servidor, usando o SSE-S3.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`
: obrigatório Não
** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) **
O tópico ARN do Amazon SNS no qual você deseja que o Amazon Textract publique o status de conclusão da operação.
Tipo: objeto [NotificationChannel](API_NotificationChannel.md)
: obrigatório Não
** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **
Define se a saída irá para um intervalo definido pelo cliente. Por padrão, o Amazon Textract salvará os resultados internamente para serem acessados pelo`GetExpenseAnalysis`operação.
Tipo: objeto [OutputConfig](API_OutputConfig.md)
: obrigatório Não
## Sintaxe da resposta
```
{
"JobId": "string"
}
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) **
Um identificador exclusivo para o trabalho de detecção de texto. O`JobId`é retornado de`StartExpenseAnalysis`. UMA`JobId`O valor só é válido por 7 dias.
Type: String
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.
Padrão: `^[a-zA-Z0-9-_]+$`
## Erros
** AccessDeniedException **
Você não está autorizado a executar a ação. Use o nome de recurso da Amazon (ARN) de um usuário autorizado ou a função do IAM para executar a operação.
Código de status HTTP: 400
** BadDocumentException **
O Amazon Textract não consegue ler o documento. Para obter mais informações sobre os limites de documentos no Amazon Textract, consulte[Limites rígidos no Amazon Textract](limits.md).
Código de status HTTP: 400
** DocumentTooLargeException **
O documento não pode ser processado porque é muito grande. O tamanho máximo do documento para operações síncronas 10 MB. O tamanho máximo do documento para operações assíncronas é de 500 MB para arquivos PDF.
Código de status HTTP: 400
** IdempotentParameterMismatchException **
UMA`ClientRequestToken`Um parâmetro de entrada foi reutilizado com uma operação, mas pelo menos um dos outros parâmetros de entrada é diferente da chamada anterior para a operação.
Código de status HTTP: 400
** InternalServerError **
O Amazon Textract teve um problema de serviço. Tente fazer a chamada novamente.
Código de status HTTP: 500
** InvalidKMSKeyException **
Indica que você não tem permissões de descriptografia com a chave KMS inserida ou a chave KMS foi inserida incorretamente.
Código de status HTTP: 400
** InvalidParameterException **
Um parâmetro de entrada violou uma restrição. Por exemplo, em operações síncronas, um`InvalidParameterException`exceção ocorre quando nenhum dos`S3Object`ou`Bytes`valores são fornecidos na`Document`Parâmetro de solicitação. Valide seu parâmetro antes de chamar a operação de API novamente.
Código de status HTTP: 400
** InvalidS3ObjectException **
O Amazon Textract não pode acessar o objeto do S3 especificado na solicitação. para obter mais informações,[Configuração de acesso ao Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Para obter informações sobre a solução de problemas, consulte[Solução de problemas do Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)
Código de status HTTP: 400
** LimitExceededException **
Um limite de serviço do Amazon Textract foi excedido. Por exemplo, se você iniciar muitos trabalhos assíncronos simultaneamente, chamadas para iniciar operações (`StartDocumentTextDetection`, por exemplo) geram uma exceção LimitExceededException (código de status HTTP: 400) até que o número de trabalhos simultâneos fique abaixo do limite de serviço do Amazon Textract.
Código de status HTTP: 400
** ProvisionedThroughputExceededException **
O número de solicitações excedeu o limite da taxa de transferência. Se precisar aumentar esse limite, entre em contato com o Amazon Textract.
Código de status HTTP: 400
** ThrottlingException **
O Amazon Textract está temporariamente indisponível para processar a solicitação. Tente fazer a chamada novamente.
Código de status HTTP: 500
** UnsupportedDocumentException **
O formato do documento de entrada não é suportado. Os documentos para operações podem estar no formato PNG, JPEG, PDF ou TIFF.
Código de status HTTP: 400
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)