

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

# AnalyzeDocument
<a name="API_AnalyzeDocument"></a>

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
<a name="API_AnalyzeDocument_RequestSyntax"></a>

```
{
   "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 name="API_AnalyzeDocument_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
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) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
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) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
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
<a name="API_AnalyzeDocument_ResponseSyntax"></a>

```
{
   "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
<a name="API_AnalyzeDocument_ResponseElements"></a>

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 name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
A versão do modelo usado para analisar o documento.  
Type: String

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
Os itens que são detectados e analisados por`AnalyzeDocument`.  
Type: Matriz de[Block](API_Block.md)objetos

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
Metadados sobre o documento analisado. Um exemplo é o número de páginas.  
Tipo: objeto [DocumentMetadata](API_DocumentMetadata.md)

 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
Mostra os resultados do humano na avaliação de loop.  
Tipo: objeto [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)

## Erros
<a name="API_AnalyzeDocument_Errors"></a>

 ** 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
<a name="API_AnalyzeDocument_SeeAlso"></a>

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) 