AnalyzeID - Amazon Textract
Syntaxe de la demandeParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

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.

AnalyzeID

Analyse les documents d'identité à la recherche d'informations pertinentes. Ces informations sont extraites et renvoyées sous la formeIdentityDocumentFields, qui enregistre à la fois le champ normalisé et la valeur du texte extrait. Contrairement aux autres opérations Amazon Textract,AnalyzeIDne renvoie aucune donnée de géométrie.

Syntaxe de la demande

{
   "DocumentPages": [ 
      { 
         "Bytes": blob,
         "S3Object": { 
            "Bucket": "string",
            "Name": "string",
            "Version": "string"
         }
      }
   ]
}

Paramètres de demande

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

DocumentPages

Le document transmis à AnalyzeID.

Type : Tableau deDocumentobjets

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 2 éléments.

Nécessaire : Oui

Syntaxe de la réponse

{
   "AnalyzeIDModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "IdentityDocuments": [ 
      { 
         "DocumentIndex": number,
         "IdentityDocumentFields": [ 
            { 
               "Type": { 
                  "Confidence": number,
                  "NormalizedValue": { 
                     "Value": "string",
                     "ValueType": "string"
                  },
                  "Text": "string"
               },
               "ValueDetection": { 
                  "Confidence": number,
                  "NormalizedValue": { 
                     "Value": "string",
                     "ValueType": "string"
                  },
                  "Text": "string"
               }
            }
         ]
      }
   ]
}

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.

AnalyzeIDModelVersion

La version de l'API AnalyzeIdentity utilisée pour traiter des documents.

Type : Chaîne

DocumentMetadata

Informations sur le document d'entrée.

Type : objet DocumentMetadata

IdentityDocuments

Liste des documents traités par AnalyzeID. Comprend un numéro indiquant leur place dans la liste et la structure de réponse du document.

Type : Tableau deIdentityDocumentobjets

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.

HTTP Status Code : 400

BadDocumentException

Amazon Textract n'est pas en mesure de lire le document. Pour plus d'informations sur les limites de documents dans Amazon Textract, voirLimites strictes dans Amazon Textract.

HTTP Status Code : 400

DocumentTooLargeException

Le document ne peut pas être traité car il est trop volumineux. Taille maximale du document pour les opérations synchrone 10 Mo. La taille maximale du document pour les opérations asynchrones est de 500 Mo pour les fichiers PDF.

HTTP Status Code : 400

InternalServerError

Amazon Textract a rencontré un problème de service. Renouvelez votre appel.

HTTP Status Code : 500

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.

HTTP Status Code : 400

InvalidS3ObjectException

Amazon Textract est dans l'impossibilité d'accéder à l'objet S3 spécifié dans la demande. Pour plus d'informations,Configuration de l'accès à Amazon S3Pour plus d'informations sur le dépannage, consultezRésolutions des problèmes liés à Amazon S3

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

UnsupportedDocumentException

Le format du document d'entrée n'est pas pris en charge. Les documents utilisés pour les opérations peuvent être au format PNG, JPEG, PDF ou TIFF.

HTTP Status Code : 400

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 :