Engineering guide
Taxonomie des erreurs API pour les pipelines de fichiers
Definissez des classes d'erreur stables et actionnables pour les API d'upload et de traitement.
Code
Securite
Document
Image
Video
Audio
Archive
Pourquoi une taxonomie d'erreur est importante
Sans taxonomie stable, clients et support ne peuvent pas distinguer les erreurs utilisateur des defauts plateforme. Un modele d'erreur type ameliore la logique de retry, la qualite de la telemetrie et le triage des incidents.
Classes recommandees
- input_invalid : entree utilisateur mal formee ou contraire a la politique.
- type_mismatch : desaccord entre extension, signature et parseur.
- processing_failed : echec de decode, transcodage ou extraction.
- resource_limited : quota, timeout ou budget de concurrence depasse.
- internal_error : faute de service inattendue.
Regles operationnelles
Chaque classe doit pointer vers des status codes deterministes, une politique de retry et des motifs de message destines aux utilisateurs. Instrumentez les metriques par classe et code raison afin que les regressions soient mesurables.
Outils recommandes