Instructions

Les Instructions guident le processus d'extraction en fournissant des indications sur comment extraire les données. Elles peuvent cibler les "General fields" (extraits une fois) ou les "Line fields" (extraits pour chaque ligne).

Créer une Instruction

POST https://api.koncile.ai/v1/create_instruction

Crée une nouvelle Instruction dans un Template.

Paramètres de requête

template_id Integer Obligatoire L'identifiant du Template contenant l'Instruction

Corps de la requête

content String Obligatoire Le texte de l'instruction

type String Obligatoire Le type cible : "General fields" ou "Line fields"

Retourne

L'objet Instruction créé.

curl -X POST "https://api.koncile.ai/v1/create_instruction/?template_id=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"content": "Extraire le numéro de facture en haut à droite du document", "type": "General fields"}'

import requests

response = requests.post(
    "https://api.koncile.ai/v1/create_instruction/",
    params={"template_id": 10},
    json={
        "content": "Extraire le numéro de facture en haut à droite du document",
        "type": "General fields"
    },
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/create_instruction/?template_id=10", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({
    content: "Extraire le numéro de facture en haut à droite du document",
    type: "General fields"
  })
});
const data = await response.json();

Récupérer une Instruction

GET https://api.koncile.ai/v1/fetch_instruction

Récupère toutes les informations d'une Instruction en utilisant l'instruction_id.

Paramètres de requête

instruction_id Integer Obligatoire L'identifiant de l'Instruction à récupérer

Retourne

L'objet Instruction.

curl "https://api.koncile.ai/v1/fetch_instruction?instruction_id=200" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

response = requests.get(
    "https://api.koncile.ai/v1/fetch_instruction",
    params={"instruction_id": 200},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/fetch_instruction?instruction_id=200", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});
const data = await response.json();

Mettre à jour une Instruction

PUT https://api.koncile.ai/v1/update_instruction

Met à jour une Instruction en utilisant l'instruction_id.

Paramètres de requête

instruction_id Integer Obligatoire L'identifiant de l'Instruction à modifier

Corps de la requête

content String Optionnel Le nouveau texte de l'instruction

type String Optionnel Le nouveau type cible : "General fields" ou "Line fields"

Retourne

L'objet Instruction modifié.

curl -X PUT "https://api.koncile.ai/v1/update_instruction?instruction_id=200" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"content": "Nouveau contenu de l instruction", "type": "Line fields"}'

import requests

response = requests.put(
    "https://api.koncile.ai/v1/update_instruction",
    params={"instruction_id": 200},
    json={"content": "Nouveau contenu de l'instruction", "type": "Line fields"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/update_instruction?instruction_id=200", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({content: "Nouveau contenu de l'instruction", type: "Line fields"})
});
const data = await response.json();

Supprimer une Instruction

DELETE https://api.koncile.ai/v1/delete_instruction

Supprime une Instruction en utilisant l'instruction_id.

Paramètres de requête

instruction_id Integer Obligatoire L'identifiant de l'Instruction à supprimer

Retourne

Réponse vide en cas de succès.

curl -X DELETE "https://api.koncile.ai/v1/delete_instruction?instruction_id=200" \
  -H "Authorization: Bearer $API_KEY"

Structure de l'objet Instruction

id Integer Identifiant unique de l'Instruction

content String Le texte de l'instruction

type String Le type cible : "General fields" ou "Line fields"

template_id Integer L'identifiant du Template parent

Exemple :

{
  "id": 200,
  "content": "Extraire le numéro de facture en haut à droite du document",
  "type": "General fields",
  "template_id": 10
}

PreviousFields NextDocuments

Last updated 19 days ago

Was this helpful?

hashtagCréer une Instruction

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagRécupérer une Instruction

hashtagParamètres de requête

hashtagRetourne

hashtagMettre à jour une Instruction

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagSupprimer une Instruction

hashtagParamètres de requête

hashtagRetourne

hashtagStructure de l'objet Instruction

Créer une Instruction

Paramètres de requête

Corps de la requête

Retourne

Récupérer une Instruction

Paramètres de requête

Retourne

Mettre à jour une Instruction

Paramètres de requête

Corps de la requête

Retourne

Supprimer une Instruction

Paramètres de requête

Retourne

Structure de l'objet Instruction