StartDocumentAnalysis

Lance l'analyse asynchrone d'un document d'entrée pour les relations entre des éléments détectés tels que des paires de clé-valeur, des tableaux et des éléments de sélection.

StartDocumentAnalysispeut analyser du texte dans des documents au format JPEG, PNG, TIFF et PDF. Les documents sont stockés dans un compartiment Amazon S3. UtiliserDocumentLocationpour spécifier le nom du compartiment et le nom du fichier du document.

StartDocumentAnalysisrenvoie un identifiant de tâche (JobId) que vous utilisez pour obtenir les résultats de l'opération. Lorsque l'analyse de texte est terminée, Amazon Textract publie un état d'achèvement dans la rubrique Amazon Simple Notification Service (Amazon SNS) que vous spécifiez dansNotificationChannel. Pour obtenir les résultats de l'opération d'analyse 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.

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

Syntaxe de la demande

{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}

Paramètres de demande

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

ClientRequestToken

Le jeton idempotent que vous utilisez pour identifier la demande de démarrage. Si vous utilisez le même jeton avec plusieursStartDocumentAnalysisdemandes, les mêmesJobIdest renvoyé. UtiliserClientRequestTokenpour éviter que le même travail ne soit lancé accidentellement plus d'une fois. Pour de plus amples informations, veuillez consulterAppel d'opérations asynchrones Amazon Textract.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.

Modèle : ^[a-zA-Z0-9-_]+$

Obligatoire Non

DocumentLocation

Emplacement du document à traiter.

Type : objet DocumentLocation

Obligatoire Oui

FeatureTypes

Liste des types d'analyses à effectuer. Ajoutez TABLES à la liste pour renvoyer des informations sur les tables détectées dans le document d'entrée. Ajoutez FORMS pour renvoyer les données de formulaire détectées. Pour effectuer les deux types d'analyse, ajoutez TABLES et FORMS àFeatureTypes. Toutes les lignes et tous les mots détectés dans le document sont inclus dans la réponse (y compris le texte qui n'est pas lié à la valeur deFeatureTypes).

Type : Tableau de chaînes

Valeurs valides : TABLES | FORMS

Obligatoire Oui

JobTag

Identifiant que vous spécifiez inclus dans la notification de fin publiée sur la rubrique Amazon SNS. Par exemple, vous pouvez utiliserJobTagpour identifier le type de document auquel correspond la notification d'achèvement (tel qu'un formulaire fiscal ou un reçu).

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.

Modèle : [a-zA-Z0-9_.\-:]+

Obligatoire Non

KMSKeyId

Clé KMS utilisée pour chiffrer les résultats de l'inférence. Cela peut être au format Key ID ou Key Alias. Lorsqu'une clé KMS est fournie, la clé KMS est utilisée pour le chiffrement côté serveur des objets du compartiment client. Lorsque ce paramètre n'est pas activé, le résultat est chiffré côté serveur, à l'aide de SSE-S3.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

Obligatoire Non

NotificationChannel

L'ARN de rubrique Amazon SNS sur lequel vous souhaitez qu'Amazon Textract publie l'état d'achèvement de l'opération.

Type : objet NotificationChannel

Obligatoire Non

OutputConfig

Définit si la sortie sera envoyée à un compartiment défini par le client. Par défaut, Amazon Textract enregistre les résultats en interne pour que l'opération GetDocumentAnalysis puisse y accéder.

Type : objet OutputConfig

Obligatoire Non

Syntaxe de la réponse

{
   "JobId": "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.

JobId

Identificateur du document de tâche de détection de texte de document. UtiliserJobIdpour identifier la tâche lors d'un appel ultérieur àGetDocumentAnalysis. 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-_]+$

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

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.

Code d'état HTTP : 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.

Code d'état HTTP : 400

IdempotentParameterMismatchException

UNClientRequestTokenLe paramètre d'entrée a été réutilisé avec une opération, mais au moins un des autres paramètres d'entrée est différent de l'appel précédent à 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

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 n'est pas en mesure d'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

LimitExceededException

Une limite de service Amazon Textract a été dépassée. Par exemple, si vous démarrez un trop grand nombre de tâches asynchrones simultanément, des appels pour démarrer des opérations (StartDocumentTextDetection, par exemple) génère une exception LimitExceededException (code de statut HTTP : 400) jusqu'à ce que le nombre de tâches exécutées simultanément soit inférieur à la limite de service Amazon Textract.

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

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.

Code d'état HTTP : 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 :

• 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