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.
# GetDocumentAnalysis
Obtient les résultats d'une opération asynchrone Amazon Textract qui analyse du texte dans un document.
Vous commencez l'analyse de texte asynchrone en appelant[StartDocumentAnalysis](API_StartDocumentAnalysis.md), qui renvoie un identifiant de tâche (`JobId`). Lorsque l'opération d'analyse 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 à`StartDocumentAnalysis`. 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`GetDocumentAnalysis`, et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartDocumentAnalysis`.
`GetDocumentAnalysis`renvoie un tableau de[Block](API_Block.md)objets. Les types d'informations suivants sont renvoyés :
+ Données de formulaire (paires clé-valeur). Les informations associées sont renvoyées dans deux[Block](API_Block.md)objets, chacun de type`KEY_VALUE_SET`: une clé`Block`objet et une VALEUR`Block`objet. Par exemple,*Name : Ana Silva Caroline*contient une clé et une valeur. *Name :*est la clé. *Ana Silva Caroline*est la valeur.
+ Données de cellules de table et de tableau. TABLE`Block`contient des informations sur une table détectée. UNE CELLULE`Block`est renvoyé pour chaque cellule d'un tableau.
+ Lignes et mots de texte. UNE LIGNE`Block`l'objet contient un ou plusieurs mots`Block`objets. Toutes les lignes et tous les mots détectés dans le document sont renvoyés (y compris le texte qui n'a pas de relation avec la valeur du`StartDocumentAnalysis` `FeatureTypes`paramètre d'entrée).
Les éléments de sélection tels que les cases à cocher et les boutons d'option (boutons radio) peuvent être détectés dans les données de formulaire et dans les tableaux. UN ÉLÉMENT SÉLECTION\$1`Block`contient des informations sur un élément de sélection, y compris l'état de la sélection.
Utilisation de l'`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`GetDocumentAnalysis`, puis remplissez-le`NextToken`paramètre request avec la valeur du jeton renvoyée par l'appel précédent à`GetDocumentAnalysis`.
Pour de plus amples informations, veuillez consulter[Analyse de texte de document](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Syntaxe de la demande
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **
Identifiant unique du travail de détection de texte. Le`JobId`est renvoyée par`StartDocumentAnalysis`. 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_GetDocumentAnalysis_RequestSyntax) **
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, seuls 1 000 résultats sont renvoyés au maximum. La valeur par défaut est 1,000.
Type : Entier
Plage valide : Valeur minimale est 1.
Obligatoire Non
** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **
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
```
{
"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 ]
}
]
}
```
## Eléments de réponse
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.
** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **
Type : Chaîne
** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **
Les résultats de l'opération d'analyse de texte.
Type : Grappe de[Block](API_Block.md)objets
** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **
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_GetDocumentAnalysis_ResponseSyntax) **
Statut actuel du travail de détection de texte.
Type : Chaîne
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **
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_GetDocumentAnalysis_ResponseSyntax) **
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_GetDocumentAnalysis_ResponseSyntax) **
Liste des avertissements survenus pendant l'opération d'analyse de documents.
Type : Grappe de[Warning](API_Warning.md)objets
## Erreurs
** 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.
Code d'état HTTP : 400
** InternalServerError **
Amazon Textract a rencontré un problème de service. Renouvelez votre appel.
Code d'état HTTP : 500
** InvalidJobIdException **
Un identifiant de tâche non valide a été transmis à[GetDocumentAnalysis](#API_GetDocumentAnalysis)ou à[GetDocumentAnalysis](#API_GetDocumentAnalysis).
Code d'état HTTP : 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.
Code d'état HTTP : 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.
Code d'état HTTP : 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)
Code d'état HTTP : 400
** ProvisionedThroughputExceededException **
Le nombre de demandes dépasse votre limite de débit. Si vous avez besoin d'augmenter cette limite, contactez Amazon Textract.
Code d'état HTTP : 400
** ThrottlingException **
Amazon Textract est temporairement dans l'impossibilité de traiter la demande. Renouvelez votre appel.
Code d'état HTTP : 500
## Voir aussi
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/GetDocumentAnalysis)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis)