GetExpenseAnalysis - Amazon Textract

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.

GetExpenseAnalysis

Obtient les résultats d'une opération asynchrone Amazon Textract qui analyse les factures et les reçus. Amazon Textract trouve les informations de contact, les articles achetés et le nom du fournisseur, à partir des factures d'entrée et des reçus.

Vous commencez une analyse asynchrone des factures et des reçus en appelantStartExpenseAnalysis, 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 estSUCCEEDED. Si c'est le cas, appelezGetExpenseAnalysis, 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 dansMaxResults, la valeur deNextTokendans 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, appelezGetExpenseAnalysis, et remplissez-leNextTokenparamètre request avec la valeur du jeton renvoyée par l'appel précédent àGetExpenseAnalysis.

Pour de plus amples informations, veuillez consulterAnalyse des factures et des reçus.

Syntaxe de la demande

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

Paramètres de demande

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

JobId

Identifiant unique du travail de détection de texte. LeJobIdest renvoyé parStartExpenseAnalysis. UNJobIdn'est valide que pendant 7 jours.

Type : Chaîne

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

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

Obligatoire Oui

MaxResults

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

Si la réponse précédente était incomplète (car il y a plus de blocs à récupérer), Amazon Textract renvoie un jeton de pagination dans la réponse. Vous pouvez utiliser ce jeton de pagination pour récupérer l'ensemble de blocs suivant.

Type : Chaîne

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

Modèle : .*\S.*

Obligatoire Non

Syntaxe de la réponse

{ "AnalyzeExpenseModelVersion": "string", "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ], "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] }

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

AnalyzeExpenseModelVersion

La version modèle actuelle d'AnalyzeExpense.

Type : Chaîne

DocumentMetadata

Informations sur un document traité par Amazon Textract.DocumentMetadataest renvoyé sur chaque page de réponses paginées provenant d'une opération Amazon Textract.

Type : objet DocumentMetadata

ExpenseDocuments

Les dépenses détectées par Amazon Textract.

Type : Tableau deExpenseDocumentobjets

JobStatus

Statut actuel de la tâche de détection de texte.

Type : Chaîne

Valeurs valides : IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS

NextToken

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

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

Liste des avertissements survenus pendant l'opération de détection de texte pour le document.

Type : Tableau deWarningobjets

Erreurs

AccessDeniedException

Vous n'êtes pas autorisé à effectuer l'action. Utilisez l'Amazon Resource Name (ARN) d'un utilisateur ou d'un rôle IAM autorisé pour effectuer l'opération.

HTTP Status Code : 400

InternalServerError

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

HTTP Status Code : 500

InvalidJobIdException

Un identifiant de tâche non valide a été transmis àGetDocumentAnalysisou àGetDocumentAnalysis.

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, unInvalidParameterExceptionexception se produit lorsque aucune des optionsS3ObjectouBytesles valeurs sont fournies dans leDocumentparamètre de demande. Validez votre paramètre avant d'appeler à nouveau l'opération d'API.

HTTP Status Code : 400

InvalidS3ObjectException

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

HTTP Status Code : 400

ProvisionedThroughputExceededException

Le nombre de demandes dépasse votre limite de débit. Si vous avez besoin d'augmenter cette limite, contactez Amazon Textract.

HTTP Status Code : 400

ThrottlingException

Amazon Textract est temporairement dans l'impossibilité de traiter la demande. Renouvelez votre appel.

HTTP Status Code : 500

Voir aussi

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :