Upload de fichiers

Le téléchargement de fichiers permet d'initier le traitement des données dans Koncile en envoyant des fichiers pour analyse avec les paramètres nécessaires comme folder_id et template_id. L'API retourne une liste d'identifiants de tâches (task_ids) correspondant aux processus individuels du fichier.

Lorsque folder_id ou template_id sont laissés vides, l'auto-classification s'applique. Le système sélectionne le Folder et les Templates correspondant le mieux au document. En cas d'échec de l'auto-classification, les fichiers doivent être classifiés manuellement sur la plateforme.

Upload file

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

Télécharge une liste de fichiers vers l'API Koncile.

Limitations

Pages maximales par document 150

Formats supportés PDF, JPEG, PNG

Taille maximale (PDF) 300 Mo

Taille maximale (PNG/JPEG) 10 Mo

Paramètres de requête

folder_id Integer Optionnel Identifiant du Folder de stockage

template_id Integer Optionnel Identifiant du Template d'extraction

doc_id Integer Optionnel Identifiant du document à compléter

Corps de la requête

files files Obligatoire Objets File à télécharger

metadata string Optionnel Chaîne JSON avec informations contextuelles (max 1000 caractères)

Retourne

task_ids Array Liste d'identifiants de tâches pour récupération

curl -X POST "https://api.koncile.ai/v1/upload_file/" \
  -H "Authorization: Bearer $API_KEY" \
  -F "folder_id=123" \
  -F "template_id=456" \
  -F "[email protected]"

import requests

with open("facture.pdf", "rb") as f:
    response = requests.post(
        "https://api.koncile.ai/v1/upload_file/",
        params={"folder_id": 123, "template_id": 456},
        files={"files": f},
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
print(response.json())

const fs = require("fs");
const FormData = require("form-data");

const form = new FormData();
form.append("files", fs.createReadStream("facture.pdf"));

const response = await fetch(
  "https://api.koncile.ai/v1/upload_file/?folder_id=123&template_id=456",
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    },
    body: form
  }
);
const data = await response.json();

Exemple de réponse :

{
  "task_ids": ["EOBdOSUX4Uv57YWsLYc4JQ", "cUrsd2ClWXa8vzupWQ2zGQ"]
}

Paramètre Metadata

Le paramètre metadata permet de passer des informations contextuelles qui seront utilisées pendant le processus d'extraction.

Format Chaîne JSON valide

Longueur maximale 1000 caractères

Utilité Améliore la précision en fournissant des détails sur le fournisseur, dates, devises

Exemple de metadata :

{
  "supplier_name": "Acme Corporation",
  "expected_invoice_date": "2024-01-15",
  "currency": "EUR",
  "department": "Achats"
}

curl -X POST "https://api.koncile.ai/v1/upload_file/" \
  -H "Authorization: Bearer $API_KEY" \
  -F "folder_id=123" \
  -F "template_id=456" \
  -F "metadata={\"supplier_name\": \"Acme Corp\", \"currency\": \"EUR\"}" \
  -F "[email protected]"

import requests
import json

metadata = json.dumps({"supplier_name": "Acme Corporation", "currency": "EUR"})

with open("facture.pdf", "rb") as f:
    response = requests.post(
        "https://api.koncile.ai/v1/upload_file/",
        params={"folder_id": 123, "template_id": 456},
        data={"metadata": metadata},
        files={"files": f},
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
print(response.json())

const fs = require("fs");
const FormData = require("form-data");

const metadata = JSON.stringify({supplier_name: "Acme Corporation", currency: "EUR"});

const form = new FormData();
form.append("files", fs.createReadStream("facture.pdf"));
form.append("metadata", metadata);

const response = await fetch(
  "https://api.koncile.ai/v1/upload_file/?folder_id=123&template_id=456",
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    },
    body: form
  }
);
const data = await response.json();

Bonnes pratiques pour les Metadata

Utilisez les metadata pour les informations contextualisant le document (détails fournisseur, valeurs attendues, devise)
Maintenez la concision et la pertinence pour l'extraction
Assurez la validité du format JSON pour éviter les erreurs de validation

PreviousGuide Python NextRécupération des tâches

Last updated 19 days ago

Was this helpful?

hashtagUpload file

hashtagLimitations

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagParamètre Metadata

hashtagBonnes pratiques pour les Metadata