Migration depuis l'ancienne API
Ce qui change
L'ancien flux utilisait :
- Header :
X-TOKEN-KEY - Routes :
/api/open/evaluation/*
Le flux actuel utilise :
- Header :
X-API-Key - Routes :
/api/keath/public/v1/*
Correspondance
| Ancien | Nouveau |
|---|---|
X-TOKEN-KEY | X-API-Key |
POST /api/open/evaluation/start | POST /api/keath/public/v1/evaluations |
GET /api/open/evaluation/result | GET /api/keath/public/v1/evaluations/:taskId |
| Ancien polling | GET /api/keath/public/v1/evaluations/:taskId/status |
| Hypothèse implicite sur le modèle | GET /api/keath/public/v1/models |
Nouveau modèle mental
Avant, vous envoyiez directement du contenu et des rubrics.
Maintenant, vous devez choisir l'un des deux chemins :
Chemin assignment :
- récupérer un
model_id - créer un assignment
- corriger avec
assignment_id
- récupérer un
Chemin one-pass :
- récupérer un
model_id - envoyer modèle, question, rubric et copie dans une seule demande
- récupérer un
Évaluation asynchrone fiable
POST /evaluations/one-pass et POST /evaluations/batch renvoient HTTP 202 Accepted avec un task_id public. Ajoutez un Idempotency-Key : une nouvelle tentative réseau identique récupère la même tâche au lieu d'en créer une autre. Le batch accepte de 1 à 100 éléments.
Les étapes sont QUEUED, UPLOADING, SUBMITTED, PROGRESS, puis SUCCESS, FAILURE ou CANCEL. Les credits sont débités uniquement après validation d'un résultat complet. Utilisez un polling limité dans le temps avec backoff.
Pour compatibilité, POST /evaluations avec un assignment existant conserve l'ancien chemin : il commence normalement par PENDING et débite les credits à l'acceptation. Son statut initial et sa facturation diffèrent donc de one-pass et batch.
À modifier côté client
- Remplacer
X-TOKEN-KEYparX-API-Key. - Remplacer
/api/open/evaluation/*par/api/keath/public/v1/*. - Ne pas utiliser
model_idcommeassignment_id. - Envoyer les copies à
POST /evaluationssi un assignment existe. - Envoyer les demandes directes à
POST /evaluations/one-passsi aucun assignment ne doit être créé. - Poller
GET /evaluations/:taskId/status. - Lire le résultat final avec
GET /evaluations/:taskId.
Formats de fichiers
La nouvelle API accepte maintenant les copies en texte ou en fichier :
- images
- DOCX
- TXT
- RTF
Pour Google Docs, exportez d'abord en DOCX, PDF ou texte. L'import OAuth Google Docs direct n'est pas inclus dans public v1.
Test de validation
Avant de migrer tout le trafic, vérifiez :
GET /creditsfonctionne.GET /modelsretourne le modèle attendu.POST /assignmentsretourne unassignment_id.POST /evaluationsretourne untask_id.- Le polling se termine par
SUCCESS,FAILUREouCANCEL. - Le code client ne contient plus
X-TOKEN-KEY.