

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

# GetDocumentTextDetection
<a name="API_GetDocumentTextDetection"></a>

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

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Parâmetros de solicitação
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
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) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
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) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
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
<a name="API_GetDocumentTextDetection_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetDocumentTextDetection_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.

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
Os resultados da operação de detecção de texto.  
Type: Matriz de[Block](API_Block.md)objetos

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
Type: String

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
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
<a name="API_GetDocumentTextDetection_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

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