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. # StartDocumentTextDetection Démarre la détection asynchrone de texte dans un document. Amazon Textract peut détecter les lignes de texte et les mots qui constituent une ligne de texte. `StartDocumentTextDetection`peut analyser du texte dans des documents au format JPEG, PNG, TIFF et PDF. Les documents sont stockés dans un compartiment Amazon S3. Utiliser[DocumentLocation](API_DocumentLocation.md)pour spécifier le nom du compartiment et le nom du fichier du document. `StartTextDetection`renvoie un identifiant de tâche (`JobId`) que vous utilisez pour obtenir les résultats de l'opération. Lorsque la détection de texte est terminée, Amazon Textract publie un état d'achèvement dans la rubrique Amazon Simple Notification Service (Amazon SNS) que vous avez spécifiée dans`NotificationChannel`. 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](API_GetDocumentTextDetection.md), et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartDocumentTextDetection`. 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 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "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](#API_StartDocumentTextDetection_RequestSyntax) ** Jeton idempotent utilisé pour identifier la demande de démarrage. Si vous utilisez le même jeton avec plusieurs`StartDocumentTextDetection`demandes, les mêmes`JobId`est renvoyé. Utiliser`ClientRequestToken`pour éviter que le même travail ne soit lancé accidentellement plus d'une fois. Pour de plus amples informations, veuillez consulter[Appel d'opérations asynchrones Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/api-async.html). Type : Chaîne Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64. Modèle : `^[a-zA-Z0-9-_]+$` Obligatoire Non ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) ** Emplacement du document à traiter. Type : objet [DocumentLocation](API_DocumentLocation.md) Obligatoire Oui ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) ** Identifiant que vous spécifiez inclus dans la notification de fin publiée sur la rubrique Amazon SNS. Par exemple, vous pouvez utiliser`JobTag`pour 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](#API_StartDocumentTextDetection_RequestSyntax) ** La 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](#API_StartDocumentTextDetection_RequestSyntax) ** 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](API_NotificationChannel.md) Obligatoire Non ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) ** 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 pouvoir être consultés avec l'opération GetDocumentTextDetection. Type : objet [OutputConfig](API_OutputConfig.md) 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](#API_StartDocumentTextDetection_ResponseSyntax) ** Identificateur de la tâche de détection de texte pour le document. Utiliser`JobId`pour identifier la tâche lors d'un appel ultérieur à`GetDocumentTextDetection`. 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-_]+$` ## 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, voir[Limites strictes dans Amazon Textract](limits.md). 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 ** IdempotentParameterMismatchException ** UN`ClientRequestToken`Le 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. HTTP Status Code : 400 ** InternalServerError ** Amazon Textract a rencontré un problème de service. Renouvelez votre appel. HTTP Status Code : 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. 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 n'est pas en mesure d'accéder à l'objet S3 spécifié dans la demande. Pour plus d'informations,[Configuration de 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 ** 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. 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 : + [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection) + [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) + [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection) + [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection) + [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) + [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection)