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 appelantStartDocumentAnalysis, 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 estSUCCEEDED. Si c'est le cas, appelezGetDocumentAnalysis, et transmettez l'identificateur de la tâche (JobId) depuis l'appel initial àStartDocumentAnalysis.

GetDocumentAnalysisrenvoie un tableau deBlockobjets. Les types d'informations suivants sont renvoyés :

• Données de formulaire (paires clé-valeur). Les informations associées sont renvoyées dans deuxBlockobjets, chacun de typeKEY_VALUE_SET: une cléBlockobjet et une VALEURBlockobjet. Par exemple,Name : Ana Silva Carolinecontient une clé et une valeur. Name :est la clé. Ana Silva Carolineest la valeur.

• Données de cellules de table et de tableau. TABLEBlockcontient des informations sur une table détectée. UNE CELLULEBlockest renvoyé pour chaque cellule d'un tableau.

• Lignes et mots de texte. UNE LIGNEBlockl'objet contient un ou plusieurs motsBlockobjets. 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 duStartDocumentAnalysis FeatureTypesparamè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_Blockcontient des informations sur un élément de sélection, y compris l'état de la sélection.

Utilisation de l'MaxResultspour limiter le nombre de blocs renvoyés. S'il y a plus de résultats que ceux spécifiés dansMaxResults, la valeur deNextTokendans 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, appelezGetDocumentAnalysis, puis remplissez-leNextTokenparamètre request avec la valeur du jeton renvoyée par l'appel précédent àGetDocumentAnalysis.

Pour de plus amples informations, veuillez consulterAnalyse de texte de document.

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

Identifiant unique du travail de détection de texte. LeJobIdest renvoyée parStartDocumentAnalysis. UNJobIdn'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

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

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

Type : Chaîne

Blocks

Les résultats de l'opération d'analyse de texte.

Type : Grappe deBlockobjets

DocumentMetadata

Informations sur un document traité par Amazon Textract.DocumentMetadataest renvoyé sur chaque page de réponses paginées provenant d'une opération vidéo Amazon Textract.

Type : objet DocumentMetadata

JobStatus

Statut actuel du travail de détection de texte.

Type : Chaîne

Valeurs valides : IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS

NextToken

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

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

Liste des avertissements survenus pendant l'opération d'analyse de documents.

Type : Grappe deWarningobjets

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 àGetDocumentAnalysisou à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, unInvalidParameterExceptionexception se produit lorsque aucune des optionsS3ObjectouBytesles valeurs sont fournies dans leDocumentparamè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 S3Pour plus d'informations sur le dépannage, consultezRésolutions des problèmes liés à Amazon S3

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

• AWS SDK pour .NET

• Kit AWS SDK pour C++

• Kit AWS SDK pour Go

• AWSSDK pour Java V2

• Kit AWS SDK pour JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWSSDK pour Ruby V3