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.
# Actions
Les actions suivantes sont prises en charge :
+ [AnalyzeDocument](API_AnalyzeDocument.md)
+ [AnalyzeExpense](API_AnalyzeExpense.md)
+ [AnalyzeID](API_AnalyzeID.md)
+ [DetectDocumentText](API_DetectDocumentText.md)
+ [GetDocumentAnalysis](API_GetDocumentAnalysis.md)
+ [GetDocumentTextDetection](API_GetDocumentTextDetection.md)
+ [GetExpenseAnalysis](API_GetExpenseAnalysis.md)
+ [StartDocumentAnalysis](API_StartDocumentAnalysis.md)
+ [StartDocumentTextDetection](API_StartDocumentTextDetection.md)
+ [StartExpenseAnalysis](API_StartExpenseAnalysis.md)
# AnalyzeDocument
Analyse un document d'entrée afin de rechercher des relations entre les éléments détectés.
Les types d'informations renvoyées sont les suivants :
+ 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 table. UNE 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 de`FeatureTypes`).
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.
Vous pouvez choisir le type d'analyse à effectuer en spécifiant le`FeatureTypes`liste.
La sortie est renvoyée dans une liste de`Block`objets.
`AnalyzeDocument`est une opération synchrone. Pour analyser des documents de manière asynchrone, utilisez[StartDocumentAnalysis](API_StartDocumentAnalysis.md).
Pour de plus amples informations, veuillez consulter[Analyse du texte du document](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).
## Syntaxe de la demande
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"FeatureTypes": [ "string" ],
"HumanLoopConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"FlowDefinitionArn": "string",
"HumanLoopName": "string"
}
}
```
## Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
** [Document](#API_AnalyzeDocument_RequestSyntax) **
Le document d'entrée sous forme d'octets codés en base64 ou d'un objet Amazon S3. Si vous utilisez l'interface de ligne de commande AWS pour appeler les opérations Amazon Textract, vous ne pouvez pas transmettre d'octets d'image. Le document doit être une image au format JPEG, PNG, PDF ou TIFF.
Si vous utilisez un kit SDK AWS pour appeler Amazon Textract, il est possible que vous n'ayez pas besoin de coder en base64 octets d'image transmis à l'aide de l'option`Bytes`.
Type : objet [Document](API_Document.md)
Obligatoire Oui
** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **
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 de`FeatureTypes`).
Type : Tableau de chaînes
Valeurs valides :` TABLES | FORMS`
Obligatoire Oui
** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **
Définit la configuration du flux de travail humain dans la boucle pour analyser les documents.
Type : objet [HumanLoopConfig](API_HumanLoopConfig.md)
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
},
"HumanLoopActivationOutput": {
"HumanLoopActivationConditionsEvaluationResults": "string",
"HumanLoopActivationReasons": [ "string" ],
"HumanLoopArn": "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.
** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **
Version du modèle utilisée pour analyser le document.
Type : Chaîne
** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **
Les éléments détectés et analysés par`AnalyzeDocument`.
Type : Tableau de[Block](API_Block.md)objets
** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **
Métadonnées concernant le document analysé. Par exemple, le nombre de pages est le nombre de pages.
Type : objet [DocumentMetadata](API_DocumentMetadata.md)
** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **
Affiche les résultats de l'évaluation humaine dans la boucle.
Type : objet [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)
## 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
** HumanLoopQuotaExceededException **
Indique que vous avez dépassé le nombre maximum d'humains actifs dans les flux de travail en boucle disponibles
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, 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
** 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/AnalyzeDocument)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument)
# AnalyzeExpense
`AnalyzeExpense`analyse de manière synchrone un document d'entrée pour détecter les relations financières entre le texte.
Les informations sont renvoyées sous la forme`ExpenseDocuments`et se sont séparés comme suit.
+ `LineItemGroups`- Un ensemble de données contenant`LineItems`qui stockent des informations sur les lignes de texte, telles qu'un article acheté et son prix sur un reçu.
+ `SummaryFields`- Contient toutes les autres informations d'un reçu, telles que les informations d'en-tête ou le nom du fournisseur.
## Syntaxe de la demande
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
** [Document](#API_AnalyzeExpense_RequestSyntax) **
Le document d'entrée, soit en octets, soit en tant qu'objet S3.
Pour transmettre des octets d'image à une opération d'API Amazon Textract, utilisez la commande`Bytes`propriété. Par exemple, utilisez la commande`Bytes`pour transmettre un document chargé à partir d'un système de fichiers local. Octets d'image transmis à l'aide de l'option`Bytes`doit être codée en base64. Il est possible que votre code n'ait pas besoin de coder des octets de fichiers de documents si vous utilisez un kit SDK AWS pour appeler les opérations de l'API Amazon Textract.
Pour transmettre des images stockées dans un compartiment S3 à une opération d'API Amazon Textract, utilisez la commande`S3Object`propriété. Il n'est pas nécessaire d'encoder en base64 les documents stockés dans un compartiment S3.
La région AWS du compartiment S3 contenant l'objet S3 doit correspondre à la région AWS que vous utilisez pour les opérations Amazon Textract.
Si vous utilisez l'AWS CLI pour appeler des opérations Amazon Textract, la transmission d'octets d'image à l'aide de la propriété Bytes n'est pas prise en charge. Vous devez d'abord charger le document dans un compartiment Amazon S3, puis appeler l'opération à l'aide de la propriété S3Object.
Pour qu'Amazon Textract traite un objet S3, l'utilisateur doit disposer des autorisations permettant d'accéder à l'objet S3.
Type : objet [Document](API_Document.md)
Regatoire : Oui
## Syntaxe de la réponse
```
{
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"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.
** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **
Informations sur le document d'entrée.
Type : objet [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **
Les dépenses détectées par Amazon Textract.
Type : Tableau de[ExpenseDocument](API_ExpenseDocument.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
** 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).
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
** InternalServerError **
Amazon Textract a rencontré un problème de service. Renouvelez votre appel.
Code d'état HTTP : 500
** 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 n'est pas en mesure d'accéder à l'objet S3 spécifié dans la demande. Pour plus d'informations, consultez la page[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)
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 prise 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense)
# AnalyzeID
Analyse les documents d'identité à la recherche d'informations pertinentes. Ces informations sont extraites et renvoyées sous la forme`IdentityDocumentFields`, qui enregistre à la fois le champ normalisé et la valeur du texte extrait. Contrairement aux autres opérations Amazon Textract,`AnalyzeID`ne 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](#API_AnalyzeID_RequestSyntax) **
Le document transmis à AnalyzeID.
Type : Tableau de[Document](API_Document.md)objets
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](#API_AnalyzeID_ResponseSyntax) **
La version de l'API AnalyzeIdentity utilisée pour traiter des documents.
Type : Chaîne
** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **
Informations sur le document d'entrée.
Type : objet [DocumentMetadata](API_DocumentMetadata.md)
** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **
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 de[IdentityDocument](API_IdentityDocument.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.
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
** 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, 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 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 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
** 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/AnalyzeID)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID)
# DetectDocumentText
Détecte le texte dans le document d'entrée. Amazon Textract peut détecter les lignes de texte et les mots qui constituent une ligne de texte. Le document d'entrée doit être une image au format JPEG, PNG, PDF ou TIFF.`DetectDocumentText`renvoie le texte détecté dans un tableau de[Block](API_Block.md)objets.
Chaque page de document est associée`Block`de type PAGE. Chaque PAGE`Block`objet est le parent de LINE`Block`objets qui représentent les lignes de texte détecté sur une page. UNE LIGNE`Block`objet est un parent pour chaque mot qui constitue la ligne. Les mots sont représentés par`Block`objets de type WORD.
`DetectDocumentText`est une opération synchrone. Pour analyser des documents de manière asynchrone, utilisez[StartDocumentTextDetection](API_StartDocumentTextDetection.md).
Pour de plus amples informations, veuillez consulter[Détection de texte de document](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).
## Syntaxe de la demande
```
{
"Document": {
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
}
```
## Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
** [Document](#API_DetectDocumentText_RequestSyntax) **
Le document d'entrée sous forme d'octets codés en base64 ou d'un objet Amazon S3. Si vous utilisez l'interface de ligne de commande AWS pour appeler les opérations Amazon Textract, vous ne pouvez pas transmettre d'octets d'image. Le document doit être une image au format JPEG ou PNG.
Si vous utilisez un kit SDK AWS pour appeler Amazon Textract, il est possible que vous n'ayez pas besoin de coder en base64 octets d'image transmis à l'aide de l'option`Bytes`.
Type : objet [Document](API_Document.md)
Obligatoire Oui
## Syntaxe de la réponse
```
{
"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"
}
],
"DetectDocumentTextModelVersion": "string",
"DocumentMetadata": {
"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.
** [Blocks](#API_DetectDocumentText_ResponseSyntax) **
Tableau d'éléments`Block`objets contenant le texte détecté dans le document.
Type : Tableau de[Block](API_Block.md)objets
** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **
Type : Chaîne
** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **
Métadonnées concernant le document. Il contient le nombre de pages détectées dans le document.
Type : objet [DocumentMetadata](API_DocumentMetadata.md)
## 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
** 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, 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
** 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/DetectDocumentText)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText)
# 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)
# GetDocumentTextDetection
Obtient les résultats d'une opération asynchrone Amazon Textract qui détecte du texte dans un document. Amazon Textract peut détecter les lignes de texte et les mots qui constituent une ligne de texte.
Vous commencez la détection de texte asynchrone en appelant[StartDocumentTextDetection](API_StartDocumentTextDetection.md), qui renvoie un identifiant de tâche (`JobId`). Lorsque l'opération de détection 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 à`StartDocumentTextDetection`. 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`, et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartDocumentTextDetection`.
`GetDocumentTextDetection`renvoie un tableau de[Block](API_Block.md)objets.
Chaque page de document est associée`Block`de type PAGE. Chaque PAGE`Block`objet est le parent de LINE`Block`objets qui représentent les lignes de texte détecté sur une page. UNE LIGNE`Block`objet est un parent pour chaque mot qui constitue la ligne. Les mots sont représentés par`Block`objets de type WORD.
Utilisez le paramètre 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`GetDocumentTextDetection`, et remplissez-le`NextToken`paramètre request avec la valeur du jeton renvoyée par l'appel précédent à`GetDocumentTextDetection`.
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
```
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Paramètres de demande
Cette demande accepte les données suivantes au format JSON.
** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **
Identifiant unique du travail de détection de texte. Le`JobId`est renvoyée par`StartDocumentTextDetection`. 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_GetDocumentTextDetection_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, un maximum de 1 000 résultats est renvoyé. La valeur par défaut est 1,000.
Type : Entier
Plage valide : Valeur minimale est 1.
Obligatoire Non
** [NextToken](#API_GetDocumentTextDetection_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
```
{
"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"
}
],
"DetectDocumentTextModelVersion": "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.
** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **
Les résultats de l'opération de détection de texte.
Type : Grappes de[Block](API_Block.md)objets
** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **
Type : Chaîne
** [DocumentMetadata](#API_GetDocumentTextDetection_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_GetDocumentTextDetection_ResponseSyntax) **
Statut actuel du travail de détection de texte.
Type : Chaîne
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetDocumentTextDetection_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_GetDocumentTextDetection_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_GetDocumentTextDetection_ResponseSyntax) **
Liste des avertissements survenus pendant l'opération de détection de texte pour le document.
Type : Grappes 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.
HTTP Status Code : 400
** InternalServerError **
Amazon Textract a rencontré un problème de service. Renouvelez votre appel.
HTTP Status Code : 500
** InvalidJobIdException **
Un identifiant de tâche non valide a été transmis à[GetDocumentAnalysis](API_GetDocumentAnalysis.md)ou à[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
HTTP Status Code : 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.
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 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)
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
## 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/GetDocumentTextDetection)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection)
# GetExpenseAnalysis
Obtient les résultats d'une opération asynchrone Amazon Textract qui analyse les factures et les reçus. Amazon Textract trouve les informations de contact, les articles achetés et le nom du fournisseur, à partir des factures d'entrée et des reçus.
Vous commencez une analyse asynchrone des factures et des reçus en appelant[StartExpenseAnalysis](API_StartExpenseAnalysis.md), qui renvoie un identifiant de tâche (`JobId`). Une fois l'analyse de la facturation/de la réception terminée, Amazon Textract publie l'état d'achèvement dans la rubrique Amazon Simple Notification Service (Amazon SNS). Cette rubrique doit être enregistrée lors de l'appel initial à`StartExpenseAnalysis`. Pour obtenir les résultats de l'analyse de facturation/réception, assurez-vous tout d'abord que la valeur d'état publiée sur la rubrique Amazon SNS est`SUCCEEDED`. Si c'est le cas, appelez`GetExpenseAnalysis`, et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartExpenseAnalysis`.
Utilisez le paramètre 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 de résultats suivant. Pour obtenir la page de résultats suivante, appelez`GetExpenseAnalysis`, et remplissez-le`NextToken`paramètre request avec la valeur du jeton renvoyée par l'appel précédent à`GetExpenseAnalysis`.
Pour de plus amples informations, veuillez consulter[Analyse des factures et des reçus](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.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_GetExpenseAnalysis_RequestSyntax) **
Identifiant unique du travail de détection de texte. Le`JobId`est renvoyé par`StartExpenseAnalysis`. 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_GetExpenseAnalysis_RequestSyntax) **
Nombre maximal de résultats à renvoyer par appel paginé. La valeur la plus élevée que vous pouvez spécifier est 20. Si vous spécifiez une valeur supérieure à 20, seuls 20 résultats sont renvoyés au maximum. La valeur par défaut est 20.
Type : Entier
Plage valide : Valeur minimale est 1.
Obligatoire Non
** [NextToken](#API_GetExpenseAnalysis_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 de blocs suivant.
Type : Chaîne
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 255.
Modèle : `.*\S.*`
Obligatoire Non
## Syntaxe de la réponse
```
{
"AnalyzeExpenseModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
],
"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.
** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **
La version modèle actuelle d'AnalyzeExpense.
Type : Chaîne
** [DocumentMetadata](#API_GetExpenseAnalysis_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 Amazon Textract.
Type : objet [DocumentMetadata](API_DocumentMetadata.md)
** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **
Les dépenses détectées par Amazon Textract.
Type : Tableau de[ExpenseDocument](API_ExpenseDocument.md)objets
** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **
Statut actuel de la tâche de détection de texte.
Type : Chaîne
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS`
** [NextToken](#API_GetExpenseAnalysis_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_GetExpenseAnalysis_ResponseSyntax) **
Renvoie si le travail de détection n'a pas pu être exécuté. Contient une explication de l'erreur survenue.
Type : Chaîne
** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **
Liste des avertissements survenus pendant l'opération de détection de texte pour le document.
Type : Tableau 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.
HTTP Status Code : 400
** InternalServerError **
Amazon Textract a rencontré un problème de service. Renouvelez votre appel.
HTTP Status Code : 500
** InvalidJobIdException **
Un identifiant de tâche non valide a été transmis à[GetDocumentAnalysis](API_GetDocumentAnalysis.md)ou à[GetDocumentAnalysis](API_GetDocumentAnalysis.md).
HTTP Status Code : 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.
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,[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)
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
## 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/GetExpenseAnalysis)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis)
# 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.
`StartDocumentAnalysis`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.
`StartDocumentAnalysis`renvoie 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 dans`NotificationChannel`. 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 est`SUCCEEDED`. Si c'est le cas, appelez[GetDocumentAnalysis](API_GetDocumentAnalysis.md), et transmettez l'identificateur de la tâche (`JobId`) depuis l'appel initial à`StartDocumentAnalysis`.
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
```
{
"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](#API_StartDocumentAnalysis_RequestSyntax) **
Le jeton idempotent que vous utilisez pour identifier la demande de démarrage. Si vous utilisez le même jeton avec plusieurs`StartDocumentAnalysis`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_StartDocumentAnalysis_RequestSyntax) **
Emplacement du document à traiter.
Type : objet [DocumentLocation](API_DocumentLocation.md)
Obligatoire Oui
** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **
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 de`FeatureTypes`).
Type : Tableau de chaînes
Valeurs valides :` TABLES | FORMS`
Obligatoire Oui
** [JobTag](#API_StartDocumentAnalysis_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_StartDocumentAnalysis_RequestSyntax) **
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_StartDocumentAnalysis_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_StartDocumentAnalysis_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 que l'opération GetDocumentAnalysis puisse y accéder.
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_StartDocumentAnalysis_ResponseSyntax) **
Identificateur du document de tâche de détection de texte de document. Utiliser`JobId`pour identifier la tâche lors d'un appel ultérieur à`GetDocumentAnalysis`. 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.
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, voir[Limites strictes dans Amazon Textract](limits.md).
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 **
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.
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, 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 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 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
** 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](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis)
# 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)
# StartExpenseAnalysis
Lance l'analyse asynchrone des factures ou des reçus pour des données telles que les informations de contact, les articles achetés et les noms des fournisseurs.
`StartExpenseAnalysis`peut analyser du texte dans des documents au format JPEG, PNG et PDF. Les documents doivent être stockés dans un compartiment Amazon S3. Utilisation de l'[DocumentLocation](API_DocumentLocation.md)pour spécifier le nom de votre compartiment S3 et le nom du document dans ce compartiment S3.
`StartExpenseAnalysis`renvoie un identifiant de tâche (`JobId`) que vous allez fournir à`GetExpenseAnalysis`pour récupérer les résultats de l'opération. Lorsque l'analyse des factures et des reçus d'entrée est terminée, Amazon Textract publie un état d'achèvement dans la rubrique Amazon Simple Notification Service (Amazon SNS) que vous fournissez au`NotificationChannel`. Pour obtenir les résultats de l'opération d'analyse des factures et des reçus, assurez-vous que la valeur d'état publiée sur la rubrique Amazon SNS est`SUCCEEDED`. Si c'est le cas, appelez[GetExpenseAnalysis](API_GetExpenseAnalysis.md), et transmettez l'identificateur de la tâche (`JobId`) qui a été renvoyé par votre appel à`StartExpenseAnalysis`.
Pour de plus amples informations, veuillez consulter[Analyse des factures et des reçus](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.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_StartExpenseAnalysis_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_StartExpenseAnalysis_RequestSyntax) **
Emplacement du document à traiter.
Type : objet [DocumentLocation](API_DocumentLocation.md)
Obligatoire Oui
** [JobTag](#API_StartExpenseAnalysis_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_StartExpenseAnalysis_RequestSyntax) **
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_StartExpenseAnalysis_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_StartExpenseAnalysis_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 qu'ils soient accessibles par le`GetExpenseAnalysis`.
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_StartExpenseAnalysis_ResponseSyntax) **
Identifiant unique de la tâche de détection de texte. Le`JobId`est renvoyé par`StartExpenseAnalysis`. 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/StartExpenseAnalysis)
+ [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis)
+ [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis)
+ [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis)
+ [Kit AWS SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis)
+ [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)