Traitement de documents avec des appels d’API séparés

Un scénario typique de traitement de documents à l’aide d’appels d’API séparés (pour créer une transaction, charger un fichier et démarrer une transaction) comprend les étapes suivantes :

Réception d’une liste de toutes les compétences disponibles
Création d’une transaction vide
Ajout d’un ensemble de fichiers à traiter dans la transaction
Démarrage de la transaction
Suivi de l’état de la transaction
Téléchargement des fichiers source et des fichiers de résultat

Chaque requête envoyée au serveur doit inclure des informations d’authentification (par exemple un jeton d’accès). Pour plus d’informations, consultez Authentication.

Récupérer la liste de toutes les compétences disponibles

Pour ce faire, envoyez une requête GET à la ressource skills : Exécutez la commande suivante : La réponse contiendra un fichier JSON semblable à ce qui suit :

[
   {
      "id": "Receipt",
      "name": "Receipt",
      "type": "Document"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "NewClassifier",
      "type": "Classification"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "Invoice",
      "type": "Document"
   }
]

Définissez l’identifiant de la compétence que vous allez utiliser. Des descriptions détaillées des compétences sont disponibles dans les compétences intégrées.

Création d’une transaction vide

Pour cela, envoyez la requête POST suivante à la ressource transactions : Exécutez la commande suivante : Après la création réussie d’une transaction vide, vous recevrez une réponse contenant l’identifiant de la transaction :

{
   "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Ajout d’un ensemble de fichiers à traiter dans la transaction

Le nombre maximal de fichiers dans une transaction est de 1 000.

Un ensemble de fichiers peut être ajouté de deux manières :

Directement à la transaction
À un Document, puis ajouter ce Document à la transaction

Ajout de fichiers directement à la transaction

Pour ce faire, envoyez une requête POST vers la ressource transactions/<transaction-id>/files : Exécutez la commande suivante : En conséquence, vous recevrez une réponse contenant la liste des fichiers ajoutés et leurs identifiants. Vous pouvez ajouter autant de fichiers que nécessaire en répétant cet appel autant de fois que nécessaire. Options supplémentaires pour le chargement des fichiers :

Ajout de fichiers à un document

Commencez par créer un document en envoyant une requête POST à la ressource transactions/<transaction-id>/documents : Vous recevrez alors une réponse contenant l’identifiant du document. Ajoutez ensuite des fichiers au document en envoyant une requête POST à la ressource transactions/<transaction-id>/documents/<document-id>/sourceFiles :

Démarrer la transaction

Pour démarrer la transaction avec la compétence et les fichiers spécifiés, envoyez la requête POST suivante à la ressource transactions/<transaction-id>/start :

Suivi du statut de la transaction

Pour commencer à surveiller le statut de la transaction à l’aide d’une boucle avec un court délai d’attente (nous ne recommandons pas de vérifier le statut plus d’une fois par seconde), envoyez une requête GET à la ressource transactions/<transaction_id> en incluant l’identifiant de la transaction dans l’URI de la requête : La réponse ressemblera à ce qui suit :

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

Dans la réponse :

Si la valeur de la clé status est définie sur :
- New — la transaction est créée, mais n’est pas actuellement en cours.
- Processing — la transaction a démarré, mais les résultats ne sont pas encore prêts.
- Processed — la transaction a été traitée avec succès, et vous pourrez télécharger les résultats.
- Failed — la transaction a échoué.
- Canceled — la transaction a été annulée.
La clé manualReviewLink contiendra un lien vers l’interface web du client de relecture manuelle et un jeton d’accès Vantage, si une relecture manuelle est requise. Ce lien et ce jeton peuvent être utilisés pour relire et corriger les résultats de classification et d’extraction de champs d’une transaction donnée. Tant que la relecture n’est pas terminée, la valeur de la clé status sera définie sur Processing. Le lien fourni est valide pendant 168 heures, après quoi un nouveau lien doit être créé et obtenu pour une nouvelle période de 168 heures à l’aide de la même méthode. Pour en savoir plus, consultez Intégration de la relecture manuelle.

Les utilisateurs autorisés via ce lien ne peuvent ni afficher ni modifier d’autres documents ou transactions.

Pour une Compétence de document, la réponse ressemblera maintenant à ce qui suit :

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "resultFiles": [
            {
               "fileId": "3a3e6245-48e1-489a-9fef-a10b5ba28515",
               "type": "Json"
            }
         ],
         "businessRulesErrors": []
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

Dans le tableau documents, chaque document possède un tableau resultFiles. Utilisez ce tableau pour obtenir les valeurs fileId. Le format des fichiers de sortie est défini par la compétence que vous utilisez. Actuellement, toutes les compétences renvoient les champs extraits au format JSON. Pour une Skill de classification, la réponse reçue une fois les documents traités ressemblera à ceci :

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "classification": {
            "isResultClassConfident": true,
            "resultClass": "Invoice",
            "classConfidences": [
               {
                  "class": "Invoice",
                  "confidence": 89
               },
               {
                  "class": "PurchaseOrder",
                  "confidence": 32
               }
            ]
         }
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

Extrayez la classe du document à partir de la clé resultClass et vérifiez le niveau de confiance de chaque classe probable dans les clés confidence. Pour une Compétence de processus, la réponse peut contenir tout ou partie des informations renvoyées pour les compétences Document et Classification, selon les stages disponibles dans la Compétence de processus.

Téléchargement des fichiers source et des fichiers de résultat

Une fois le traitement terminé, vous pouvez télécharger deux types de fichiers :

Fichiers source — les fichiers d’origine que vous avez téléversés, renvoyés dans leur format binaire d’origine.
Fichiers de résultat — la sortie du traitement : les données extraites, au format JSON par défaut (le format de sortie est défini par la compétence).

Les fichiers source et les fichiers de résultat utilisent des points de terminaison différents et des identifiants de fichier différents :

Fichier source — GET transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download. L’ID du fichier provient de la réponse GET transactions/<transaction-id>/documents (sourceFiles[].id).
Fichier de résultat — GET transactions/<transaction-id>/files/<file-id>/download. L’ID du fichier provient du tableau resultFiles dans la réponse de statut de la transaction (documents[].resultFiles[].fileId).

Pour obtenir la liste des documents avec leurs identifiants, envoyez une requête GET à la ressource transactions/<transaction-id>/documents et indiquez l’identifiant de la transaction : Par conséquent, vous recevrez la liste de tous les documents créés dans cette transaction. La réponse contient également les identifiants de ces documents, qui peuvent être nécessaires pour obtenir des informations détaillées sur des documents spécifiques.

Fichiers source

Pour télécharger un fichier source requis, envoyez une requête GET à la ressource transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download et indiquez les identifiants de la transaction, du document et du fichier (issus de la dernière réponse) : Exécutez la commande suivante : La réponse contiendra le fichier au format binaire. Répétez cette étape pour tous vos fichiers source.

Fichiers de résultat

Pour télécharger un fichier de résultat, envoyez une requête GET à la ressource transactions/<transaction-id>/files/<file-id>/download et indiquez l’identifiant de la transaction ainsi que le fileId du fichier de résultat. Récupérez le fileId dans le tableau resultFiles renvoyé lors de la surveillance du statut de la transaction (chaque entrée comporte un fileId et un type, par exemple Json) : Exécutez la commande suivante :

​Récupérer la liste de toutes les compétences disponibles

​Création d’une transaction vide

​Ajout d’un ensemble de fichiers à traiter dans la transaction

​Ajout de fichiers directement à la transaction

​Ajout de fichiers à un document

​Démarrer la transaction

​Suivi du statut de la transaction

​Téléchargement des fichiers source et des fichiers de résultat

​Fichiers source

​Fichiers de résultat

Récupérer la liste de toutes les compétences disponibles

Création d’une transaction vide

Ajout d’un ensemble de fichiers à traiter dans la transaction

Ajout de fichiers directement à la transaction

Ajout de fichiers à un document

Démarrer la transaction

Suivi du statut de la transaction

Téléchargement des fichiers source et des fichiers de résultat

Fichiers source

Fichiers de résultat