

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.

# Référence API
<a name="API_Reference"></a>

 Cette section fournit la documentation concernant les opérations API Amazon Textract.

**Topics**
+ [Actions](API_Operations.md)
+ [Types de données](API_Types.md)

# Actions
<a name="API_Operations"></a>

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
<a name="API_AnalyzeDocument"></a>

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
<a name="API_AnalyzeDocument_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "HumanLoopConfig": { 
      "DataAttributes": { 
         "ContentClassifiers": [ "string" ]
      },
      "FlowDefinitionArn": "string",
      "HumanLoopName": "string"
   }
}
```

## Paramètres de demande
<a name="API_AnalyzeDocument_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
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) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
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) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
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
<a name="API_AnalyzeDocument_ResponseSyntax"></a>

```
{
   "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
<a name="API_AnalyzeDocument_ResponseElements"></a>

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) **   <a name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
Version du modèle utilisée pour analyser le document.  
Type : Chaîne

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
Les éléments détectés et analysés par`AnalyzeDocument`.  
Type : Tableau de[Block](API_Block.md)objets

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
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) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
Affiche les résultats de l'évaluation humaine dans la boucle.  
Type : objet [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)

## Erreurs
<a name="API_AnalyzeDocument_Errors"></a>

 ** 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
<a name="API_AnalyzeDocument_SeeAlso"></a>

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
<a name="API_AnalyzeExpense"></a>

 `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
<a name="API_AnalyzeExpense_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## Paramètres de demande
<a name="API_AnalyzeExpense_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeExpense_RequestSyntax) **   <a name="Textract-AnalyzeExpense-request-Document"></a>
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
<a name="API_AnalyzeExpense_ResponseSyntax"></a>

```
{
   "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
<a name="API_AnalyzeExpense_ResponseElements"></a>

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) **   <a name="Textract-AnalyzeExpense-response-DocumentMetadata"></a>
Informations sur le document d'entrée.  
Type : objet [DocumentMetadata](API_DocumentMetadata.md)

 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-ExpenseDocuments"></a>
Les dépenses détectées par Amazon Textract.  
Type : Tableau de[ExpenseDocument](API_ExpenseDocument.md)objets

## Erreurs
<a name="API_AnalyzeExpense_Errors"></a>

 ** 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
<a name="API_AnalyzeExpense_SeeAlso"></a>

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
<a name="API_AnalyzeID"></a>

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
<a name="API_AnalyzeID_RequestSyntax"></a>

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

## Paramètres de demande
<a name="API_AnalyzeID_RequestParameters"></a>

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

 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) **   <a name="Textract-AnalyzeID-request-DocumentPages"></a>
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
<a name="API_AnalyzeID_ResponseSyntax"></a>

```
{
   "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
<a name="API_AnalyzeID_ResponseElements"></a>

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) **   <a name="Textract-AnalyzeID-response-AnalyzeIDModelVersion"></a>
La version de l'API AnalyzeIdentity utilisée pour traiter des documents.  
Type : Chaîne

 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-DocumentMetadata"></a>
Informations sur le document d'entrée.  
Type : objet [DocumentMetadata](API_DocumentMetadata.md)

 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-IdentityDocuments"></a>
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
<a name="API_AnalyzeID_Errors"></a>

 ** 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
<a name="API_AnalyzeID_SeeAlso"></a>

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
<a name="API_DetectDocumentText"></a>

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
<a name="API_DetectDocumentText_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## Paramètres de demande
<a name="API_DetectDocumentText_RequestParameters"></a>

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

 ** [Document](#API_DetectDocumentText_RequestSyntax) **   <a name="Textract-DetectDocumentText-request-Document"></a>
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
<a name="API_DetectDocumentText_ResponseSyntax"></a>

```
{
   "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
<a name="API_DetectDocumentText_ResponseElements"></a>

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) **   <a name="Textract-DetectDocumentText-response-Blocks"></a>
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) **   <a name="Textract-DetectDocumentText-response-DetectDocumentTextModelVersion"></a>
  
Type : Chaîne

 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DocumentMetadata"></a>
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
<a name="API_DetectDocumentText_Errors"></a>

 ** 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
<a name="API_DetectDocumentText_SeeAlso"></a>

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
<a name="API_GetDocumentAnalysis"></a>

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
<a name="API_GetDocumentAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Paramètres de demande
<a name="API_GetDocumentAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-JobId"></a>
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) **   <a name="Textract-GetDocumentAnalysis-request-MaxResults"></a>
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) **   <a name="Textract-GetDocumentAnalysis-request-NextToken"></a>
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
<a name="API_GetDocumentAnalysis_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetDocumentAnalysis_ResponseElements"></a>

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) **   <a name="Textract-GetDocumentAnalysis-response-AnalyzeDocumentModelVersion"></a>
  
Type : Chaîne

 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Blocks"></a>
Les résultats de l'opération d'analyse de texte.  
Type : Grappe de[Block](API_Block.md)objets

 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-DocumentMetadata"></a>
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) **   <a name="Textract-GetDocumentAnalysis-response-JobStatus"></a>
Statut actuel du travail de détection de texte.  
Type : Chaîne  
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-NextToken"></a>
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) **   <a name="Textract-GetDocumentAnalysis-response-StatusMessage"></a>
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) **   <a name="Textract-GetDocumentAnalysis-response-Warnings"></a>
Liste des avertissements survenus pendant l'opération d'analyse de documents.  
Type : Grappe de[Warning](API_Warning.md)objets

## Erreurs
<a name="API_GetDocumentAnalysis_Errors"></a>

 ** 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
<a name="API_GetDocumentAnalysis_SeeAlso"></a>

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
<a name="API_GetDocumentTextDetection"></a>

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
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Paramètres de demande
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
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) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
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) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
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
<a name="API_GetDocumentTextDetection_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

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) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
Les résultats de l'opération de détection de texte.  
Type : Grappes de[Block](API_Block.md)objets

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
Type : Chaîne

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
Statut actuel du travail de détection de texte.  
Type : Chaîne  
Valeurs valides :` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
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) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
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
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** 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
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

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
<a name="API_GetExpenseAnalysis"></a>

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
<a name="API_GetExpenseAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Paramètres de demande
<a name="API_GetExpenseAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-JobId"></a>
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) **   <a name="Textract-GetExpenseAnalysis-request-MaxResults"></a>
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) **   <a name="Textract-GetExpenseAnalysis-request-NextToken"></a>
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
<a name="API_GetExpenseAnalysis_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetExpenseAnalysis_ResponseElements"></a>

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) **   <a name="Textract-GetExpenseAnalysis-response-AnalyzeExpenseModelVersion"></a>
La version modèle actuelle d'AnalyzeExpense.  
Type : Chaîne

 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-DocumentMetadata"></a>
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) **   <a name="Textract-GetExpenseAnalysis-response-ExpenseDocuments"></a>
Les dépenses détectées par Amazon Textract.  
Type : Tableau de[ExpenseDocument](API_ExpenseDocument.md)objets

 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-JobStatus"></a>
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) **   <a name="Textract-GetExpenseAnalysis-response-NextToken"></a>
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) **   <a name="Textract-GetExpenseAnalysis-response-StatusMessage"></a>
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) **   <a name="Textract-GetExpenseAnalysis-response-Warnings"></a>
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
<a name="API_GetExpenseAnalysis_Errors"></a>

 ** 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
<a name="API_GetExpenseAnalysis_SeeAlso"></a>

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
<a name="API_StartDocumentAnalysis"></a>

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
<a name="API_StartDocumentAnalysis_RequestSyntax"></a>

```
{
   "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
<a name="API_StartDocumentAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-ClientRequestToken"></a>
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) **   <a name="Textract-StartDocumentAnalysis-request-DocumentLocation"></a>
Emplacement du document à traiter.  
Type : objet [DocumentLocation](API_DocumentLocation.md)  
Obligatoire Oui

 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-FeatureTypes"></a>
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) **   <a name="Textract-StartDocumentAnalysis-request-JobTag"></a>
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) **   <a name="Textract-StartDocumentAnalysis-request-KMSKeyId"></a>
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) **   <a name="Textract-StartDocumentAnalysis-request-NotificationChannel"></a>
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) **   <a name="Textract-StartDocumentAnalysis-request-OutputConfig"></a>
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
<a name="API_StartDocumentAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Eléments de réponse
<a name="API_StartDocumentAnalysis_ResponseElements"></a>

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) **   <a name="Textract-StartDocumentAnalysis-response-JobId"></a>
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
<a name="API_StartDocumentAnalysis_Errors"></a>

 ** 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
<a name="API_StartDocumentAnalysis_SeeAlso"></a>

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
<a name="API_StartDocumentTextDetection"></a>

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
<a name="API_StartDocumentTextDetection_RequestSyntax"></a>

```
{
   "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
<a name="API_StartDocumentTextDetection_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-ClientRequestToken"></a>
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) **   <a name="Textract-StartDocumentTextDetection-request-DocumentLocation"></a>
Emplacement du document à traiter.  
Type : objet [DocumentLocation](API_DocumentLocation.md)  
Obligatoire Oui

 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-JobTag"></a>
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) **   <a name="Textract-StartDocumentTextDetection-request-KMSKeyId"></a>
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) **   <a name="Textract-StartDocumentTextDetection-request-NotificationChannel"></a>
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) **   <a name="Textract-StartDocumentTextDetection-request-OutputConfig"></a>
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
<a name="API_StartDocumentTextDetection_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Eléments de réponse
<a name="API_StartDocumentTextDetection_ResponseElements"></a>

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) **   <a name="Textract-StartDocumentTextDetection-response-JobId"></a>
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
<a name="API_StartDocumentTextDetection_Errors"></a>

 ** 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
<a name="API_StartDocumentTextDetection_SeeAlso"></a>

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
<a name="API_StartExpenseAnalysis"></a>

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
<a name="API_StartExpenseAnalysis_RequestSyntax"></a>

```
{
   "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
<a name="API_StartExpenseAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-ClientRequestToken"></a>
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) **   <a name="Textract-StartExpenseAnalysis-request-DocumentLocation"></a>
Emplacement du document à traiter.  
Type : objet [DocumentLocation](API_DocumentLocation.md)  
Obligatoire Oui

 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-JobTag"></a>
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) **   <a name="Textract-StartExpenseAnalysis-request-KMSKeyId"></a>
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) **   <a name="Textract-StartExpenseAnalysis-request-NotificationChannel"></a>
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) **   <a name="Textract-StartExpenseAnalysis-request-OutputConfig"></a>
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
<a name="API_StartExpenseAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Eléments de réponse
<a name="API_StartExpenseAnalysis_ResponseElements"></a>

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) **   <a name="Textract-StartExpenseAnalysis-response-JobId"></a>
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
<a name="API_StartExpenseAnalysis_Errors"></a>

 ** 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
<a name="API_StartExpenseAnalysis_SeeAlso"></a>

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) 

# Types de données
<a name="API_Types"></a>

Les types de données suivants sont pris en charge :
+  [AnalyzeIDDetections](API_AnalyzeIDDetections.md) 
+  [Block](API_Block.md) 
+  [BoundingBox](API_BoundingBox.md) 
+  [Document](API_Document.md) 
+  [DocumentLocation](API_DocumentLocation.md) 
+  [DocumentMetadata](API_DocumentMetadata.md) 
+  [ExpenseDetection](API_ExpenseDetection.md) 
+  [ExpenseDocument](API_ExpenseDocument.md) 
+  [ExpenseField](API_ExpenseField.md) 
+  [ExpenseType](API_ExpenseType.md) 
+  [Geometry](API_Geometry.md) 
+  [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 
+  [HumanLoopConfig](API_HumanLoopConfig.md) 
+  [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 
+  [IdentityDocument](API_IdentityDocument.md) 
+  [IdentityDocumentField](API_IdentityDocumentField.md) 
+  [LineItemFields](API_LineItemFields.md) 
+  [LineItemGroup](API_LineItemGroup.md) 
+  [NormalizedValue](API_NormalizedValue.md) 
+  [NotificationChannel](API_NotificationChannel.md) 
+  [OutputConfig](API_OutputConfig.md) 
+  [Point](API_Point.md) 
+  [Relationship](API_Relationship.md) 
+  [S3Object](API_S3Object.md) 
+  [Warning](API_Warning.md) 

# AnalyzeIDDetections
<a name="API_AnalyzeIDDetections"></a>

Utilisé pour contenir les informations détectées par une opération AnalyzeID.

## Table des matières
<a name="API_AnalyzeIDDetections_Contents"></a>

 ** Confidence **   <a name="Textract-Type-AnalyzeIDDetections-Confidence"></a>
Le score de confiance du texte détecté.  
Type : Float  
Plage valide : La valeur minimale est fixée à 0. Valeur maximale fixée à 100.  
Obligatoire Non

 ** NormalizedValue **   <a name="Textract-Type-AnalyzeIDDetections-NormalizedValue"></a>
Retourné uniquement pour les dates, renvoie le type de valeur détectée et la date écrite de manière plus lisible par machine.  
Type : objet [NormalizedValue](API_NormalizedValue.md)  
Obligatoire Non

 ** Text **   <a name="Textract-Type-AnalyzeIDDetections-Text"></a>
Texte du champ normalisé ou de la valeur associée.  
Type : Chaîne  
Obligatoire Oui

## Voir aussi
<a name="API_AnalyzeIDDetections_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeIDDetections) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeIDDetections) 

# Block
<a name="API_Block"></a>

UN`Block`représente les éléments reconnus dans un document au sein d'un groupe de pixels proches les uns des autres. Les informations renvoyées dans un`Block`dépend du type d'opération. Dans la détection de texte pour les documents (par exemple)[DetectDocumentText](API_DetectDocumentText.md)), vous obtenez des informations sur les mots et les lignes de texte détectés. Dans l'analyse de texte (par exemple)[AnalyzeDocument](API_AnalyzeDocument.md)), vous pouvez également obtenir des informations sur les champs, les tables et les éléments de sélection détectés dans le document.

Tableau d'éléments`Block`objets sont renvoyés par des opérations synchrone et asynchrone. Dans les opérations synchrone, telles que[DetectDocumentText](API_DetectDocumentText.md), tableau de`Block`object représente l'ensemble des résultats. Dans les opérations asynchrones, telles que[GetDocumentAnalysis](API_GetDocumentAnalysis.md), la baie est renvoyée sur une ou plusieurs réponses.

Pour de plus amples informations, veuillez consulter[Fonctionnement d'Amazon Textract](https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).

## Table des matières
<a name="API_Block_Contents"></a>

 ** BlockType **   <a name="Textract-Type-Block-BlockType"></a>
Type d'élément de texte reconnu. Dans les opérations de détection de texte, les types suivants sont renvoyés :  
+  *PAGE*- Contient une liste des lignes`Block`objets détectés sur une page de document.
+  *MOT*- Un mot détecté sur une page de document. Un mot est constitué d'un ou plusieurs caractères latins de base ISO non séparés par des espaces.
+  *LIGNE*- Une chaîne de mots contigus délimités par des tabulations qui sont détectés sur une page de document.
Dans les opérations d'analyse de texte, les types suivants sont renvoyés :  
+  *PAGE*- Contient une liste des enfants`Block`objets détectés sur une page de document.
+  *KEY\$1VALUE\$1SET*- Stocke la CLÉ et la VALEUR`Block`objets pour le texte lié détecté sur une page de document. Utilisation de l'`EntityType`pour déterminer si un objet KEY\$1VALUE\$1SET est une clé`Block`objet ou VALUE`Block`objet. 
+  *MOT*- Un mot détecté sur une page de document. Un mot est constitué d'un ou plusieurs caractères latins de base ISO non séparés par des espaces.
+  *LIGNE*- Une chaîne de mots contigus délimités par des tabulations qui sont détectés sur une page de document.
+  *TABLE*- Tableau détecté sur une page de document. Un tableau est constitué d'informations basées sur une grille comportant au moins deux lignes ou colonnes, avec une plage de cellules d'une ligne et d'une colonne chacune. 
+  *CELLULE*- Une cellule dans une table détectée. La cellule est le parent du bloc contenant le texte de la cellule.
+  *SELECTION\$1ELEMENT*- Un élément de sélection tel qu'un bouton d'option (bouton radio) ou une case à cocher détectée sur une page de document. Utilisez la valeur de`SelectionStatus`pour déterminer le statut de l'élément de sélection.
Type : Chaîne  
Valeurs valides :` KEY_VALUE_SET | PAGE | LINE | WORD | TABLE | CELL | SELECTION_ELEMENT`   
Obligatoire Non

 ** ColumnIndex **   <a name="Textract-Type-Block-ColumnIndex"></a>
Colonne dans laquelle une cellule de tableau apparaît. La position de la première colonne est 1.`ColumnIndex`n'est pas renvoyé par`DetectDocumentText`et`GetDocumentTextDetection`.  
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

 ** ColumnSpan **   <a name="Textract-Type-Block-ColumnSpan"></a>
Nombre de colonnes couvrant une cellule de tableau. Actuellement, cette valeur est toujours 1, même si le nombre de colonnes échelonnées est supérieur à 1.`ColumnSpan`n'est pas renvoyé par`DetectDocumentText`et`GetDocumentTextDetection`.   
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

 ** Confidence **   <a name="Textract-Type-Block-Confidence"></a>
Le score de confiance d'Amazon Textract dans la précision du texte reconnu et la précision de la géométrie pointe autour du texte reconnu.  
Type : Float  
Plage valide : La valeur minimale est 0. Valeur maximale fixée à 100.  
Obligatoire Non

 ** EntityTypes **   <a name="Textract-Type-Block-EntityTypes"></a>
Type d'entité. Les éléments suivants peuvent être renvoyés :  
+  *CLÉ*- Identifiant d'un champ du document.
+  *VALEUR*- Le texte du champ.
 `EntityTypes`n'est pas renvoyé par`DetectDocumentText`et`GetDocumentTextDetection`.  
Type : Tableau de chaînes  
Valeurs valides :` KEY | VALUE`   
Obligatoire Non

 ** Geometry **   <a name="Textract-Type-Block-Geometry"></a>
L'emplacement du texte reconnu sur l'image. Il comprend un cadre de sélection grossier aligné sur l'axe qui entoure le texte, et un polygone à grain fin pour des informations spatiales plus précises.   
Type : objet [Geometry](API_Geometry.md)  
Obligatoire Non

 ** Id **   <a name="Textract-Type-Block-Id"></a>
Identificateur du texte reconnu. L'identifiant n'est unique que pour une seule opération.   
Type : Chaîne  
Modèle : `.*\S.*`   
Obligatoire Non

 ** Page **   <a name="Textract-Type-Block-Page"></a>
Page sur laquelle un bloc a été détecté.`Page`est renvoyé par des opérations asynchrones. Les valeurs de page supérieures à 1 ne sont renvoyées que pour les documents multipages au format PDF ou TIFF. Une image numérisée (JPEG/PNG), même si elle contient plusieurs pages de document, est considérée comme un document d'une seule page. Pour`Page`est toujours 1. Les opérations synchrone ne reviennent pas`Page`car chaque document d'entrée est considéré comme un document d'une seule page.  
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

 ** Relationships **   <a name="Textract-Type-Block-Relationships"></a>
Liste des blocs enfants du bloc actuel. Par exemple, un objet LINE comporte des blocs enfants pour chaque bloc WORD faisant partie de la ligne de texte. Il n'y a pas d'objets Relationship dans la liste pour les relations qui n'existent pas, par exemple lorsque le bloc actuel ne comporte pas de blocs enfants. La taille de la liste peut être la suivante :  
+ 0 - Le bloc ne comporte pas de blocs enfants.
+ 1 - Le bloc comporte des blocs enfants.
Type : Tableau de[Relationship](API_Relationship.md)objets  
Obligatoire Non

 ** RowIndex **   <a name="Textract-Type-Block-RowIndex"></a>
Ligne dans laquelle se trouve une cellule de tableau. La position de la première ligne est 1.`RowIndex`n'est pas renvoyé par`DetectDocumentText`et`GetDocumentTextDetection`.  
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

 ** RowSpan **   <a name="Textract-Type-Block-RowSpan"></a>
Nombre de lignes couvrant une cellule de tableau. Actuellement, cette valeur est toujours 1, même si le nombre de lignes étendues est supérieur à 1.`RowSpan`n'est pas renvoyé par`DetectDocumentText`et`GetDocumentTextDetection`.  
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

 ** SelectionStatus **   <a name="Textract-Type-Block-SelectionStatus"></a>
Statut de sélection d'un élément de sélection, tel qu'un bouton d'option ou une case à cocher.   
Type : Chaîne  
Valeurs valides :` SELECTED | NOT_SELECTED`   
Obligatoire Non

 ** Text **   <a name="Textract-Type-Block-Text"></a>
Le mot ou la ligne de texte reconnu par Amazon Textract.   
Type : Chaîne  
Obligatoire Non

 ** TextType **   <a name="Textract-Type-Block-TextType"></a>
Type de texte détecté par Amazon Textract. Peut vérifier s'il y a du texte manuscrit et du texte imprimé.  
Type : Chaîne  
Valeurs valides :` HANDWRITING | PRINTED`   
Obligatoire Non

## Voir aussi
<a name="API_Block_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Block) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Block) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Block) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Block) 

# BoundingBox
<a name="API_BoundingBox"></a>

Le cadre de sélection autour de la page, du texte, de la paire clé-valeur, du tableau, de la cellule de tableau ou de l'élément de sélection détectés sur une page de document. Le`left`(coordonnée X) et`top`(coordonnée y) représentent les coordonnée représentant les côtés supérieur et gauche du cadre de délimitation. Notez que le coin supérieur gauche de l'image est l'origine (0,0). 

Le`top`et`left`les valeurs renvoyées sont des ratios de la taille globale de la page du document. Par exemple, si l'image d'entrée a une résolution de 700 x 200 pixels, et que la coordonnée supérieure gauche du cadre de délimitation est de 350 x 50 pixels, l'API renvoie une valeur `left` de 0,5 (350/700) et une valeur `top` de 0,25 (50/200).

Le`width`et`height`Les valeurs représentent les dimensions du cadre de délimitation sous forme de ratio de la dimension de page de document globale. Par exemple, si la taille de la page du document est de 700 x 200 pixels et que la largeur du cadre de sélection est de 70 pixels, la largeur renvoyée est de 0,1. 

## Table des matières
<a name="API_BoundingBox_Contents"></a>

 ** Height **   <a name="Textract-Type-BoundingBox-Height"></a>
Height Hauteur du cadre de délimitation sous forme de ratio de la hauteur d'image globale.  
Type : Float  
Obligatoire Non

 ** Left **   <a name="Textract-Type-BoundingBox-Left"></a>
Left Coordonnée gauche du cadre de délimitation sous forme de ratio de la largeur d'image globale.  
Type : Float  
Obligatoire Non

 ** Top **   <a name="Textract-Type-BoundingBox-Top"></a>
Top Coordonnée supérieure du cadre de délimitation sous forme de ratio de la hauteur d'image globale.  
Type : Float  
Obligatoire Non

 ** Width **   <a name="Textract-Type-BoundingBox-Width"></a>
Width Largeur du cadre de délimitation sous forme de ratio de la largeur d'image globale.  
Type : Float  
Obligatoire Non

## Voir aussi
<a name="API_BoundingBox_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/BoundingBox) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/BoundingBox) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/BoundingBox) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/BoundingBox) 

# Document
<a name="API_Document"></a>

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, vous utiliseriez la commande`Bytes`pour transmettre un document chargé à partir d'un système de fichiers local. Octets d'image transmis à l'aide de la`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 les 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. 

## Table des matières
<a name="API_Document_Contents"></a>

 ** Bytes **   <a name="Textract-Type-Document-Bytes"></a>
Un blob d'octets de document codés en base64. La taille maximale d'un document fourni dans un blob d'octets est de 5 Mo. Les octets de document doivent être au format PNG ou JPEG.  
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 de données binaires encodées en base64  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 10485760.  
Obligatoire Non

 ** S3Object **   <a name="Textract-Type-Document-S3Object"></a>
Identifie un objet S3 en tant que source de document. La taille maximale d'un document stocké dans un compartiment S3 est de 5 Mo.  
Type : objet [S3Object](API_S3Object.md)  
Obligatoire Non

## Voir aussi
<a name="API_Document_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Document) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Document) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Document) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Document) 

# DocumentLocation
<a name="API_DocumentLocation"></a>

Compartiment Amazon S3 qui contient le document à traiter. Il est utilisé par des opérations asynchrones telles que[StartDocumentTextDetection](API_StartDocumentTextDetection.md).

Le document d'entrée peut être un fichier image au format JPEG ou PNG. Il peut également s'agir d'un fichier au format PDF.

## Table des matières
<a name="API_DocumentLocation_Contents"></a>

 ** S3Object **   <a name="Textract-Type-DocumentLocation-S3Object"></a>
Compartiment Amazon S3 qui contient le document d'entrée.  
Type : objet [S3Object](API_S3Object.md)  
Obligatoire Non

## Voir aussi
<a name="API_DocumentLocation_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentLocation) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentLocation) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentLocation) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentLocation) 

# DocumentMetadata
<a name="API_DocumentMetadata"></a>

Informations sur le document d'entrée.

## Table des matières
<a name="API_DocumentMetadata_Contents"></a>

 ** Pages **   <a name="Textract-Type-DocumentMetadata-Pages"></a>
Nombre de pages détectées dans le document.  
Type : Entier  
Plage valide : La valeur minimale est 0.  
Obligatoire Non

## Voir aussi
<a name="API_DocumentMetadata_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentMetadata) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentMetadata) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentMetadata) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentMetadata) 

# ExpenseDetection
<a name="API_ExpenseDetection"></a>

Objet utilisé pour stocker des informations sur la valeur ou l'étiquette détectée par Amazon Textract.

## Table des matières
<a name="API_ExpenseDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseDetection-Confidence"></a>
La confiance dans la détection, en pourcentage  
Type : Float  
Plage valide : La valeur minimale est 0. Valeur maximale fixée à 100.  
Obligatoire Non

 ** Geometry **   <a name="Textract-Type-ExpenseDetection-Geometry"></a>
Informations sur l'emplacement des éléments suivants sur une page de document : page détectée, texte, paires de clé-valeur, des tableaux, des cellules de tableau et des éléments de sélection.  
Type : objet [Geometry](API_Geometry.md)  
Obligatoire Non

 ** Text **   <a name="Textract-Type-ExpenseDetection-Text"></a>
Le mot ou la ligne de texte reconnu par Amazon Textract  
Type : Chaîne  
Obligatoire Non

## Voir aussi
<a name="API_ExpenseDetection_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDetection) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDetection) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDetection) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDetection) 

# ExpenseDocument
<a name="API_ExpenseDocument"></a>

La structure contenant toutes les informations renvoyées par AnalyzeExpense

## Table des matières
<a name="API_ExpenseDocument_Contents"></a>

 ** ExpenseIndex **   <a name="Textract-Type-ExpenseDocument-ExpenseIndex"></a>
Désigne la facture ou le reçu du document dont proviennent les informations. Le premier document sera 1, le deuxième document, et ainsi de suite.  
Type : Entier  
Plage valide : La valeur minimale est fixée à 0.  
Obligatoire Non

 ** LineItemGroups **   <a name="Textract-Type-ExpenseDocument-LineItemGroups"></a>
Informations détectées sur chaque table d'un document, divisées en`LineItems`.  
Type : Tableau de[LineItemGroup](API_LineItemGroup.md)objets  
Obligatoire Non

 ** SummaryFields **   <a name="Textract-Type-ExpenseDocument-SummaryFields"></a>
Toutes les informations trouvées en dehors d'une table par Amazon Textract.  
Type : Tableau de[ExpenseField](API_ExpenseField.md)objets  
Obligatoire Non

## Voir aussi
<a name="API_ExpenseDocument_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDocument) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDocument) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDocument) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDocument) 

# ExpenseField
<a name="API_ExpenseField"></a>

Ventilation des informations détectées, divisées en catégories Type, LabelDetection et ValueDetection

## Table des matières
<a name="API_ExpenseField_Contents"></a>

 ** LabelDetection **   <a name="Textract-Type-ExpenseField-LabelDetection"></a>
L'étiquette explicitement indiquée d'un élément détecté.  
Type : objet [ExpenseDetection](API_ExpenseDetection.md)  
Obligatoire Non

 ** PageNumber **   <a name="Textract-Type-ExpenseField-PageNumber"></a>
Numéro de page sur lequel la valeur a été détectée.  
Type : Entier  
Plage valide : La valeur minimale est fixée à 0.  
Obligatoire Non

 ** Type **   <a name="Textract-Type-ExpenseField-Type"></a>
Étiquette implicite d'un élément détecté. Présent aux côtés de LabelDetection pour les éléments explicites.  
Type : objet [ExpenseType](API_ExpenseType.md)  
Obligatoire Non

 ** ValueDetection **   <a name="Textract-Type-ExpenseField-ValueDetection"></a>
La valeur d'un élément détecté. Présent dans des éléments explicites et implicites.  
Type : objet [ExpenseDetection](API_ExpenseDetection.md)  
Obligatoire Non

## Voir aussi
<a name="API_ExpenseField_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseField) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseField) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseField) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseField) 

# ExpenseType
<a name="API_ExpenseType"></a>

Objet utilisé pour stocker des informations sur le type détecté par Amazon Textract.

## Table des matières
<a name="API_ExpenseType_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseType-Confidence"></a>
La confiance de la précision, en pourcentage.  
Type : Float  
Plage valide : La valeur minimale est fixée à 0. Valeur maximale fixée à 100.  
Obligatoire Non

 ** Text **   <a name="Textract-Type-ExpenseType-Text"></a>
Le mot ou la ligne de texte détecté par Amazon Textract.  
Type : Chaîne  
Obligatoire Non

## Voir aussi
<a name="API_ExpenseType_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseType) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseType) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseType) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseType) 

# Geometry
<a name="API_Geometry"></a>

Informations sur l'emplacement des éléments suivants sur une page de document : page détectée, texte, paires de clé-valeur, des tableaux, des cellules de tableau et des éléments de sélection.

## Table des matières
<a name="API_Geometry_Contents"></a>

 ** BoundingBox **   <a name="Textract-Type-Geometry-BoundingBox"></a>
Représentation grossière alignée sur l'axe de l'emplacement de l'élément reconnu sur la page de document.  
Type : objet [BoundingBox](API_BoundingBox.md)  
Obligatoire Non

 ** Polygon **   <a name="Textract-Type-Geometry-Polygon"></a>
Dans le cadre de sélection, un polygone à grains fins autour de l'élément reconnu.  
Type : Tableau de[Point](API_Point.md)objets  
Obligatoire Non

## Voir aussi
<a name="API_Geometry_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Geometry) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Geometry) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Geometry) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Geometry) 

# HumanLoopActivationOutput
<a name="API_HumanLoopActivationOutput"></a>

Affiche les résultats de l'évaluation humaine dans la boucle. S'il n'y a pas de HumanLooParn, l'entrée n'a pas déclenché de révision humaine.

## Table des matières
<a name="API_HumanLoopActivationOutput_Contents"></a>

 ** HumanLoopActivationConditionsEvaluationResults **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationConditionsEvaluationResults"></a>
Affiche le résultat des évaluations de l'état, y compris les conditions qui ont activé un examen humain.  
Type : Chaîne  
Contraintes de longueur : Longueur maximale de 10 240.  
Obligatoire Non

 ** HumanLoopActivationReasons **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationReasons"></a>
Démontre si et pourquoi un examen humain était nécessaire.  
Type : Tableau de chaînes  
Membres du tableau : Nombre minimum de 1 élément.  
Obligatoire Non

 ** HumanLoopArn **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopArn"></a>
Amazon Resource Name (ARN) de HumanLoop créé.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 256.  
Obligatoire Non

## Voir aussi
<a name="API_HumanLoopActivationOutput_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopActivationOutput) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopActivationOutput) 

# HumanLoopConfig
<a name="API_HumanLoopConfig"></a>

Configure le flux de travail de révision humaine vers lequel le document sera envoyé si l'une des conditions est remplie. Vous pouvez également définir certains attributs de l'image avant de les réviser. 

## Table des matières
<a name="API_HumanLoopConfig_Contents"></a>

 ** DataAttributes **   <a name="Textract-Type-HumanLoopConfig-DataAttributes"></a>
Définit les attributs des données d'entrée.  
Type : objet [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md)  
Obligatoire Non

 ** FlowDefinitionArn **   <a name="Textract-Type-HumanLoopConfig-FlowDefinitionArn"></a>
Amazon Resource Name (ARN) de la définition de flux.  
Type : Chaîne  
Contraintes de longueur : Longueur maximum de 256.  
Obligatoire Oui

 ** HumanLoopName **   <a name="Textract-Type-HumanLoopConfig-HumanLoopName"></a>
Nom du flux de travail humain utilisé pour cette image. Cela doit être unique au sein d'une région.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 63.  
Modèle : `^[a-z0-9](-*[a-z0-9])*`   
Obligatoire Oui

## Voir aussi
<a name="API_HumanLoopConfig_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopConfig) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopConfig) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopConfig) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopConfig) 

# HumanLoopDataAttributes
<a name="API_HumanLoopDataAttributes"></a>

Permet de définir les attributs de l'image. Actuellement, vous pouvez déclarer une image comme étant exempte d'informations personnelles identifiables et de contenus pour adultes. 

## Table des matières
<a name="API_HumanLoopDataAttributes_Contents"></a>

 ** ContentClassifiers **   <a name="Textract-Type-HumanLoopDataAttributes-ContentClassifiers"></a>
Définit si l'image de saisie est exempte d'informations personnelles identifiables ou de contenu pour adultes.  
Type : Tableau de chaînes  
Membres de tableau : Nombre maximal de 256 éléments.  
Valeurs valides :` FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent`   
Obligatoire Non

## Voir aussi
<a name="API_HumanLoopDataAttributes_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopDataAttributes) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopDataAttributes) 

# IdentityDocument
<a name="API_IdentityDocument"></a>

Structure qui répertorie chaque document traité dans une opération AnalyzeID.

## Table des matières
<a name="API_IdentityDocument_Contents"></a>

 ** DocumentIndex **   <a name="Textract-Type-IdentityDocument-DocumentIndex"></a>
Indique le placement d'un document dans la liste IdentityDocument. Le premier document porte la mention 1, le second 2 et ainsi de suite.  
Type : Entier  
Plage valide : La valeur minimale est fixée à 0.  
Obligatoire Non

 ** IdentityDocumentFields **   <a name="Textract-Type-IdentityDocument-IdentityDocumentFields"></a>
Structure utilisée pour enregistrer des informations extraites de documents d'identité. Contient à la fois un champ normalisé et une valeur du texte extrait.  
Type : Tableau de[IdentityDocumentField](API_IdentityDocumentField.md)objets  
Obligatoire Non

## Voir aussi
<a name="API_IdentityDocument_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocument) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocument) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocument) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocument) 

# IdentityDocumentField
<a name="API_IdentityDocumentField"></a>

Structure contenant à la fois le type normalisé des informations extraites et le texte qui y est associé. Ils sont extraits respectivement sous forme de type et de valeur.

## Table des matières
<a name="API_IdentityDocumentField_Contents"></a>

 ** Type **   <a name="Textract-Type-IdentityDocumentField-Type"></a>
Utilisé pour contenir les informations détectées par une opération AnalyzeID.  
Type : objet [AnalyzeIDDetections](API_AnalyzeIDDetections.md)  
Obligatoire Non

 ** ValueDetection **   <a name="Textract-Type-IdentityDocumentField-ValueDetection"></a>
Utilisé pour contenir les informations détectées par une opération AnalyzeID.  
Type : objet [AnalyzeIDDetections](API_AnalyzeIDDetections.md)  
Obligatoire Non

## Voir aussi
<a name="API_IdentityDocumentField_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocumentField) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocumentField) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocumentField) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocumentField) 

# LineItemFields
<a name="API_LineItemFields"></a>

Structure qui contient des informations sur les différentes lignes présentes dans les tableaux d'un document.

## Table des matières
<a name="API_LineItemFields_Contents"></a>

 ** LineItemExpenseFields **   <a name="Textract-Type-LineItemFields-LineItemExpenseFields"></a>
ExpenseFields permet d'afficher des informations provenant de lignes détectées sur une table.  
Type : Tableau de[ExpenseField](API_ExpenseField.md)objets  
Obligatoire Non

## Voir aussi
<a name="API_LineItemFields_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemFields) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemFields) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemFields) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemFields) 

# LineItemGroup
<a name="API_LineItemGroup"></a>

Un regroupement de tables contenant des éléments LineItems, chaque table étant identifiée par le`LineItemGroupIndex`.

## Table des matières
<a name="API_LineItemGroup_Contents"></a>

 ** LineItemGroupIndex **   <a name="Textract-Type-LineItemGroup-LineItemGroupIndex"></a>
Numéro utilisé pour identifier une table spécifique dans un document. La première table rencontrée aura un LineItemGroupIndex de 1, le second 2, etc.  
Type : Entier  
Plage valide : La valeur minimale est fixée à 0.  
Obligatoire Non

 ** LineItems **   <a name="Textract-Type-LineItemGroup-LineItems"></a>
La ventilation des informations sur une ligne particulière d'un tableau.   
Type : Tableau de[LineItemFields](API_LineItemFields.md)objets  
Obligatoire Non

## Voir aussi
<a name="API_LineItemGroup_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemGroup) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemGroup) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemGroup) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemGroup) 

# NormalizedValue
<a name="API_NormalizedValue"></a>

Contient des informations relatives aux dates d'un document, y compris le type de valeur et la valeur.

## Table des matières
<a name="API_NormalizedValue_Contents"></a>

 ** Value **   <a name="Textract-Type-NormalizedValue-Value"></a>
La valeur de la date, écrite sous la forme Year-Mois-Daythour:Minute:Second.  
Type : Chaîne  
Obligatoire Non

 ** ValueType **   <a name="Textract-Type-NormalizedValue-ValueType"></a>
Type normalisé de la valeur détectée. Dans ce cas, DATE.  
Type : Chaîne  
Valeurs valides :` DATE`   
Obligatoire Non

## Voir aussi
<a name="API_NormalizedValue_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NormalizedValue) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NormalizedValue) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NormalizedValue) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NormalizedValue) 

# NotificationChannel
<a name="API_NotificationChannel"></a>

Amazon Simple Notification Service (Amazon SNS) dans laquelle Amazon Textract publie l'état d'achèvement d'une opération de document asynchrone, telle que[StartDocumentTextDetection](API_StartDocumentTextDetection.md). 

## Table des matières
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="Textract-Type-NotificationChannel-RoleArn"></a>
Amazon Resource Name (ARN) d'un rôle IAM qui accorde des autorisations de publication Amazon Textract à la rubrique Amazon SNS.   
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 20. Longueur maximale de 2048.  
Modèle : `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Obligatoire Oui

 ** SNSTopicArn **   <a name="Textract-Type-NotificationChannel-SNSTopicArn"></a>
Rubrique Amazon SNS sur laquelle Amazon Textract publie l'état d'achèvement.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 20. Longueur maximum de 1024.  
Modèle : `(^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)`   
Obligatoire Oui

## Voir aussi
<a name="API_NotificationChannel_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NotificationChannel) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NotificationChannel) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NotificationChannel) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NotificationChannel) 

# OutputConfig
<a name="API_OutputConfig"></a>

Définit si votre sortie sera envoyée ou non à un compartiment créé par l'utilisateur. Permet de définir le nom du compartiment et le préfixe du fichier de sortie.

 `OutputConfig`est un paramètre facultatif qui vous permet de régler l'endroit où votre sortie sera placée. Par défaut, Amazon Textract stocke les résultats en interne et n'est accessible que par les opérations Obtenir l'API. Lorsque OutputConfig est activé, vous pouvez définir le nom du compartiment vers lequel la sortie sera envoyée et le préfixe de fichier des résultats dans lequel vous pouvez télécharger vos résultats. De plus, vous pouvez définir la`KMSKeyID`d'une clé principale de client (CMK) pour chiffrer votre sortie. Sans ce jeu de paramètres, Amazon Textract chiffrera côté serveur à l'aide du CMK géré par AWS pour Amazon S3.

Le déchiffrement du contenu client est nécessaire au traitement des documents par Amazon Textract. Si votre compte est désactivé en vertu d'une politique de désactivation des services IA, tout le contenu client non chiffré est immédiatement et définitivement supprimé une fois que le contenu client a été traité par le service. Aucune copie de la sortie n'est conservée par Amazon Textract. Pour plus d'informations sur la façon de désactiver, consultez[Gestion de la politique de désactivation des services IA.](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) 

Pour plus d'informations sur la confidentialité des données, consultez[FAQ sur la confidentialité des données](https://aws.amazon.com/compliance/data-privacy-faq/).

## Table des matières
<a name="API_OutputConfig_Contents"></a>

 ** S3Bucket **   <a name="Textract-Type-OutputConfig-S3Bucket"></a>
Le nom du compartiment vers lequel votre sortie va aller.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 3. Longueur maximale de 255.  
Modèle : `[0-9A-Za-z\.\-_]*`   
Requise : Oui

 ** S3Prefix **   <a name="Textract-Type-OutputConfig-S3Prefix"></a>
Le préfixe de la clé d'objet dans laquelle la sortie sera enregistrée. Lorsqu'il n'est pas activé, le préfixe sera « textract\$1output ».  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1024.  
Modèle : `.*\S.*`   
Requise : Non

## Voir aussi
<a name="API_OutputConfig_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/OutputConfig) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/OutputConfig) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/OutputConfig) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/OutputConfig) 

# Point
<a name="API_Point"></a>

Les coordonnées X et Y d'un point sur une page de document. Les valeurs X et Y renvoyées sont des ratios de la taille globale de la page du document. Par exemple, si le document en entrée est de 700 x 200 et que l'opération renvoie X=0,5 et Y=0,25, le point se situe à la coordonnée (350,50) pixels sur la page du document.

Tableau d'éléments`Point`objets,`Polygon`est retourné comme partie intégrante de l'[Geometry](API_Geometry.md)objet renvoyé dans un[Block](API_Block.md)objet. UN`Polygon`objet représente un polygone à grains fins autour du texte détecté, une paire clé-valeur, un tableau, une cellule de tableau ou un élément de sélection. 

## Table des matières
<a name="API_Point_Contents"></a>

 ** X **   <a name="Textract-Type-Point-X"></a>
La valeur de la coordonnée X d'un point sur un`Polygon`.  
Type : Float  
Obligatoire Non

 ** Y **   <a name="Textract-Type-Point-Y"></a>
La valeur de la coordonnée Y pour un point sur un`Polygon`.  
Type : Float  
Obligatoire Non

## Voir aussi
<a name="API_Point_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Point) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Point) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Point) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Point) 

# Relationship
<a name="API_Relationship"></a>

Informations sur la façon dont les blocs sont liés les uns aux autres. UN`Block`objet contient 0 ou plus`Relation`objets dans une liste,`Relationships`. Pour plus d'informations, consultez [Block](API_Block.md).

Le`Type`fournit le type de relation pour tous les blocs de la`IDs`tableau. 

## Table des matières
<a name="API_Relationship_Contents"></a>

 ** Ids **   <a name="Textract-Type-Relationship-Ids"></a>
Un tableau d'identifiants pour les blocs associés. Vous pouvez accéder au type de relation à partir du`Type`élément.  
Type : Tableau de chaînes  
Modèle : `.*\S.*`   
Obligatoire Non

 ** Type **   <a name="Textract-Type-Relationship-Type"></a>
Type de relation entre les blocs du tableau ID et le bloc actuel. La relation peut être`VALUE`ou`CHILD`. Une relation de type VALUE est une liste qui contient l'ID du bloc VALUE associé à la CLÉ d'une paire clé-valeur. Une relation de type CHILD est une liste d'ID qui identifie les blocs WORD dans le cas des lignes, des blocs de cellules dans le cas des tables, et des blocs WORD dans le cas des éléments de sélection.  
Type : Chaîne  
Valeurs valides :` VALUE | CHILD | COMPLEX_FEATURES`   
Obligatoire Non

## Voir aussi
<a name="API_Relationship_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Relationship) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Relationship) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Relationship) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Relationship) 

# S3Object
<a name="API_S3Object"></a>

Le nom du compartiment S3 et le nom de fichier qui identifient le document.

La région AWS du compartiment S3 qui contient le document doit correspondre à la région que vous utilisez pour les opérations Amazon Textract.

Pour qu'Amazon Textract traite un fichier dans un compartiment S3, l'utilisateur doit être autorisé à accéder au compartiment et au fichier S3. 

## Table des matières
<a name="API_S3Object_Contents"></a>

 ** Bucket **   <a name="Textract-Type-S3Object-Bucket"></a>
Nom du compartiment S3. Notez que le caractère \$1 n'est pas valide dans le nom de fichier.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 3. Longueur maximale de 255.  
Modèle : `[0-9A-Za-z\.\-_]*`   
Obligatoire Non

 ** Name **   <a name="Textract-Type-S3Object-Name"></a>
Nom de fichier du document d'entrée. Les opérations synchrone peuvent utiliser des fichiers image au format JPEG ou PNG. Les opérations asynchrones prennent également en charge les fichiers au format PDF et TIFF.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1024.  
Modèle : `.*\S.*`   
Obligatoire Non

 ** Version **   <a name="Textract-Type-S3Object-Version"></a>
Si le compartiment est activé pour la gestion des versions, vous pouvez spécifier la version de l'objet.   
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1024.  
Modèle : `.*\S.*`   
Obligatoire Non

## Voir aussi
<a name="API_S3Object_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/S3Object) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/S3Object) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/S3Object) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/S3Object) 

# Warning
<a name="API_Warning"></a>

Avertissement concernant un problème survenu lors de l'analyse de texte asynchrone ([StartDocumentAnalysis](API_StartDocumentAnalysis.md)) ou détection de texte de document asynchrone ([StartDocumentTextDetection](API_StartDocumentTextDetection.md)). 

## Table des matières
<a name="API_Warning_Contents"></a>

 ** ErrorCode **   <a name="Textract-Type-Warning-ErrorCode"></a>
Code d'erreur correspondant à l'avertissement.  
Type : Chaîne  
Obligatoire Non

 ** Pages **   <a name="Textract-Type-Warning-Pages"></a>
Liste des pages auxquelles l'avertissement s'applique.  
Type : Tableau de nombres entiers  
Plage valide : La valeur minimale est fixée à 0.  
Obligatoire Non

## Voir aussi
<a name="API_Warning_SeeAlso"></a>

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 :
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Warning) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Warning) 
+  [AWSSDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Warning) 
+  [AWSSDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Warning) 