Task Retrieval

La fonctionnalité de Task Retrieval de l’API Koncile permet de suivre en temps réel l’état des tâches liées au traitement des documents soumis. Cette fonctionnalité est essentielle pour intégrer un suivi automatisé dans vos flux de travail, garantissant ainsi une gestion optimale des documents et des informations extraites.

Lorsqu’un document est soumis à Koncile, il est traité en arrière-plan. Grâce au point de terminaison dédié au Task Retrieval, vous pouvez :

  • Vérifier l’état d’une tâche spécifique, qu’elle soit terminée (DONE), en cours (IN PROGRESS), dupliquée (DUPLICATE) ou échouée (FAILED).

  • Accéder aux informations extraites générales, telles que les dates, les prix et les noms des fournisseurs, via des champs structurés.

  • Récupérer des données détaillées au niveau des lignes pour un traitement plus précis et granulaire.

Pour interroger une tâche spécifique via l’API Koncile, utilisez la commande suivante. Cette commande cURL permet de récupérer l’état et les données associées à une tâche donnée en utilisant son task_id. Assurez-vous de remplacer {task_id} par l’ID de la tâche et `$API_KEY` par votre clé d’authentification personnelle.

curl api.koncile.ai/v1/fetch_tasks_results/?task_id={task_id} \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

Schema de réponse détaillé (Returned Schemas)

L’API renvoie une structure JSON contenant toutes les informations nécessaires pour analyser l’état et les données extraites d’une tâche. La réponse est organisée en deux sections principales :

  1. general_fields : Regroupe les données globales extraites du document, par exmple : la date, le prix total et le nom du fournisseur.

  2. line_fields : Contient les informations détaillées au niveau des lignes ou des tableaux

Voici le schéma exact de la réponse, avec les différents champs disponibles, leurs types et des exemples de valeurs. Ce format structuré facilite l’intégration des données dans vos systèmes ou flux de travail.

{
	"status": DONE | DUPLICATE | IN PROGRESS | FAILED,
	"document_id": ID,
	"status_message": "",
	"General_fields":
		{
			"Date" : {"value": "05/08/20222", "confidence_score": 0.92},
			"Price" : {"value": "23$", "confidence_score": 0.91},
			"Supplier name" : {"value": "Koncile", "confidence_score": 0.93}
		}
	,
	"Line_fields":
		{
			"Date" : [{"value": "05/08/2022"}, {"value" : "05/09/2022"}, {"value": "03/02/2023"}],
			"Price" : [{"value": "23$"}, {"value": "12$"}, {"value": "5$"}],
			"Supplier name" : [{"value": "Koncile"}, {"value": "Koncile"}, {"value": "Koncile"}]
		}
}

Last updated

Was this helpful?