Passer au contenu principal
Un scénario typique pour traiter des documents à l’aide d’un seul appel d’API (pour créer une transaction, téléverser un fichier et démarrer cette transaction) comprend les étapes suivantes :
  1. Réception de la liste de toutes les compétences disponibles
  2. Création et démarrage d’une transaction
  3. Suivi de l’état de la transaction
  4. Téléchargement des fichiers source et des fichiers de résultats
Chaque requête envoyée au serveur doit inclure des informations d’authentification. Voir Authentication pour plus de détails. Utilisez ce scénario si vous n’avez qu’un seul fichier dont la taille est inférieure à 30 Mo et que vous n’avez pas besoin de modifier les images de ce fichier.

​
Récupération de la liste de toutes les compétence disponibles

Pour ce faire, envoyez une requête GET à la ressource skills : Exécutez la commande suivante : Pour Windows : Pour Linux : La réponse contiendra un fichier JSON semblable à l’exemple suivant : Réponse :
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 et lancement d’une transaction

Pour créer et lancer une transaction afin de traiter un fichier téléversé avec la compétence spécifiée, envoyez la requête POST suivante à la ressource transactions/launch?skillId=<skill-id> : Cela crée une nouvelle transaction et la lance immédiatement. Exécutez la commande suivante : Pour Windows : Pour Linux :
Lors du téléversement du fichier dans Vantage, tous les caractères suivants du nom de fichier seront remplacés par un trait de soulignement : :/?#[]@!$&'()*+,;=\. Le nom de fichier modifié s’affichera à la fois dans l’API Vantage et dans Skill Monitor.

​
Suivi du statut de la transaction

Pour commencer à suivre 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> avec l’identifiant de la transaction dans l’URI de la requête : Exécutez la commande suivante : Pour Windows : Pour Linux : La réponse ressemblera à ceci : Réponse : Dans la réponse :
  • Si la valeur de la clé status est définie sur Processing, les résultats ne sont pas encore prêts. Une fois le statut de la transaction passé à Processed, vous pourrez télécharger les résultats.
  • 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 restera définie sur Processing. Le lien fourni est valable 168 heures, après quoi un nouveau lien devra être créé et obtenu pour une nouvelle période de 168 heures en utilisant la même méthode. Pour en savoir plus, consultez Integrating manual review.
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 alors à ceci : Réponse : Dans le tableau documents, chaque document possède un tableau resultFiles. Utilisez ce tableau pour récupérer 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 : Réponse : Extrayez la classe du document à partir de la clé resultClass et vérifiez le niveau de confiance associé à 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 de classification, selon les étapes 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 fichier :
  • 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 — le résultat 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 une liste des documents avec leurs identifiants, envoyez une requête GET à la ressource transactions/<transaction-id>/documents et indiquez l’identifiant de la transaction : Exécutez la commande suivante : Pour Windows : Pour Linux :

​
Fichiers source

Pour télécharger un fichier source donné, 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 : Pour Windows : Pour Linux : 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 : Pour Windows : Pour Linux :