

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Obtient les résultats d'une opération asynchrone Amazon Textract qui détecte du texte dans un document. Amazon Textract peut détecter les lignes de texte et les mots qui constituent une ligne de texte.

Vous commencez la détection de texte asynchrone en appelant[StartDocumentTextDetection](API_StartDocumentTextDetection.md), qui renvoie un identifiant de tâche (`JobId`). Lorsque l'opération de détection de texte est terminée, Amazon Textract publie un état d'achèvement dans la rubrique Amazon Simple Notification Service (Amazon SNS) enregistrée lors de l'appel initial à`StartDocumentTextDetection`. Pour obtenir les résultats de l'opération de détection de texte, vérifiez d'abord que la valeur d'état publiée sur la rubrique Amazon SNS est`SUCCEEDED`. Si c'est le cas, appelez`GetDocumentTextDetection`, et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartDocumentTextDetection`.

 `GetDocumentTextDetection`renvoie un tableau de[Block](API_Block.md)objets. 

Chaque page de document est associée`Block`de type PAGE. Chaque PAGE`Block`objet est le parent de LINE`Block`objets qui représentent les lignes de texte détecté sur une page. UNE LIGNE`Block`objet est un parent pour chaque mot qui constitue la ligne. Les mots sont représentés par`Block`objets de type WORD.

Utilisez le paramètre MaxResults pour limiter le nombre de blocs renvoyés. S'il y a plus de résultats que ceux spécifiés dans`MaxResults`, la valeur de`NextToken`dans la réponse d'opération contient un jeton de pagination permettant d'obtenir l'ensemble suivant de résultats. Pour obtenir la page de résultats suivante, appelez`GetDocumentTextDetection`, et remplissez-le`NextToken`paramètre request avec la valeur du jeton renvoyée par l'appel précédent à`GetDocumentTextDetection`.

Pour de plus amples informations, veuillez consulter[Détection de texte](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Syntaxe de la demande
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

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

## Paramètres de demande
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
Identifiant unique du travail de détection de texte. Le`JobId`est renvoyée par`StartDocumentTextDetection`. UN`JobId`n'est valide que pendant 7 jours.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.  
Modèle : `^[a-zA-Z0-9-_]+$`   
Obligatoire Oui

 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
Nombre maximal de résultats à renvoyer par appel paginé. La valeur la plus élevée que vous pouvez spécifier est 1 000. Si vous spécifiez une valeur supérieure à 1 000, un maximum de 1 000 résultats est renvoyé. La valeur par défaut est 1,000.  
Type : Entier  
Plage valide : Valeur minimale est 1.  
Obligatoire Non

 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
Si la réponse précédente était incomplète (car il y a plus de blocs à récupérer), Amazon Textract renvoie un jeton de pagination dans la réponse. Vous pouvez utiliser ce jeton de pagination pour récupérer l'ensemble suivant de blocs.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 255.  
Modèle : `.*\S.*`   
Obligatoire Non

## Syntaxe de la réponse
<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 ]
      }
   ]
}
```

## Eléments de réponse
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
Les résultats de l'opération de détection de texte.  
Type : Grappes de[Block](API_Block.md)objets

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

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
Informations sur un document traité par Amazon Textract.`DocumentMetadata`est renvoyé sur chaque page de réponses paginées provenant d'une opération vidéo Amazon Textract.  
Type : objet [DocumentMetadata](API_DocumentMetadata.md)

 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
Statut actuel du travail de détection de texte.  
Type : Chaîne  
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
Si la réponse est tronquée, Amazon Textract renvoie ce jeton. Vous pouvez utiliser ce jeton dans la demande suivante pour récupérer l'ensemble suivant de résultats de détection de texte.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 255.  
Modèle : `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
Renvoie si la tâche de détection n'a pas pu être exécutée. Contient une explication de l'erreur survenue.   
Type : Chaîne

 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
Liste des avertissements survenus pendant l'opération de détection de texte pour le document.  
Type : Grappes de[Warning](API_Warning.md)objets

## Erreurs
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** AccessDeniedException **   
Vous n'êtes pas autorisé à effectuer l'action. Utilisez l'Amazon Resource Name (ARN) d'un utilisateur ou d'un rôle IAM autorisé pour effectuer l'opération.  
HTTP Status Code : 400

 ** InternalServerError **   
Amazon Textract a rencontré un problème de service. Renouvelez votre appel.  
HTTP Status Code : 500

 ** InvalidJobIdException **   
Un identifiant de tâche non valide a été transmis à[GetDocumentAnalysis](API_GetDocumentAnalysis.md)ou à[GetDocumentAnalysis](API_GetDocumentAnalysis.md).  
HTTP Status Code : 400

 ** InvalidKMSKeyException **   
 Indique que vous ne disposez pas d'autorisations de déchiffrement avec la clé KMS entrée ou que la clé KMS n'a pas été saisie correctement.   
HTTP Status Code : 400

 ** InvalidParameterException **   
Un paramètre d'entrée a enfreint une contrainte. Par exemple, dans les opérations synchrone, un`InvalidParameterException`exception se produit lorsque aucune des options`S3Object`ou`Bytes`les valeurs sont fournies dans le`Document`paramètre de demande. Validez votre paramètre avant d'appeler à nouveau l'opération d'API.  
HTTP Status Code : 400

 ** InvalidS3ObjectException **   
Amazon Textract ne peut pas accéder à l'objet S3 spécifié dans la demande. Pour plus d'informations,[Configurer l'accès à Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Pour plus d'informations sur le dépannage, consultez[Résolutions des problèmes liés à Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code : 400

 ** ProvisionedThroughputExceededException **   
Le nombre de demandes dépasse votre limite de débit. Si vous avez besoin d'augmenter cette limite, contactez Amazon Textract.  
HTTP Status Code : 400

 ** ThrottlingException **   
Amazon Textract est temporairement dans l'impossibilité de traiter la demande. Renouvelez votre appel.  
HTTP Status Code : 500

## Voir aussi
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection) 
+  [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) 