Bibliothèques clientes / SDK

Bibliothèques clientes officiellement prises en charge pour intégrer la plateforme Mindee.

En utilisant les bibliothèques clientes, vous pourrez intégrer plus rapidement et réduire vos coûts de maintenance.

Quelques outils utiles sont également fournis, par exemple le traitement des PDF et la compression d’images.

Vous pouvez utiliser les bibliothèques clientes pour effectuer des requêtes API selon les schémas de polling et de webhook.

Toutes nos bibliothèques clientes sont open source (licence MIT) et hébergées sur GitHub.

Langages/frameworks pris en charge : Python, Node.js (JS/TS), PHP, Ruby, Java, .NET (C#).

Instructions d’installation

Python

Nécessite Python ≥ 3.9. Python ≥ 3.11 est recommandé.

Installez simplement le package PyPI avec pip:

pip install -U mindee~=5.1

Node.js

PHP

Ruby

Java

.NET

Vous ne voyez pas de prise en charge pour votre langage ou framework préféré ? Faites une demande de fonctionnalité !

Détails d’utilisation

Dans l’ensemble, les étapes pour utiliser le service Mindee sont :

1. Configuration du client

   1. Initialisez le client Mindee.
   2. Définissez les paramètres d’inférence, en particulier l’ID de modèle à utiliser.
2. Charger et ajuster un fichier

   1. Chargez un fichier depuis diverses sources prises en charge : chemin, octets, etc.
   2. Facultatif: ajustez le fichier source avant l’envoi.
3. Envoyer un fichier ou une URL

   1. Envoyez le fichier ou une URL avec les paramètres appropriés.
4. Traitement des réponses

   1. Facultatif : charger à partir d’un webhook.
   2. Facultatif : accéder aux métadonnées du document
5. Résultat d’extraction

   1. Traitez les valeurs des champs extraites du document
   2. Facultatif : accéder aux métadonnées des champs (polygones, score de confiance)

Questions fréquemment posées

Puis-je envoyer des requêtes en parallèle ?

Oui. Tous les clients peuvent être utilisés pour envoyer des requêtes en parallèle.

L’implémentation exacte est laissée à l’utilisateur :

• Pour Node.js, vous devrez utiliser un traitement asynchrone.
• Pour toutes les autres, vous devrez utiliser des threads ou des processus.

Puis-je utiliser les API v1 et v2 ensemble ?

Oui. Chaque bibliothèque cliente prend en charge les API v1 et v2.

Vous devrez créer une instance distincte des classes clientes :

• .NET et Java, utilisez MindeeClient et MindeeClientV2
• pour toutes les autres, utilisez Client et ClientV2

Le code pour effectuer des requêtes et traiter les résultats est très différent entre v1 et v2.

Nous recommandons vivement d’avoir des fichiers différents (voire des modules) pour gérer chaque version de l’API.

Puis-je envoyer uniquement une page précise d’un PDF multipage ?

Oui. Toutes les bibliothèques prennent en charge le découpage/l’extraction des pages PDF.

Pour plus d’informations, consultez : Charger et ajuster un fichier.

Comment empêcher l’envoi de PDF comportant trop de pages ?

N’utilisez pas la taille du fichier, un PDF textuel de 200 pages peut être plus petit qu’une seule photo.

Il est bien plus fiable de compter le nombre réel de pages du document PDF.

Utilisez les méthodes et propriétés de métadonnées de fichier intégrées pour ajouter facilement des règles métier basées sur le nombre de pages (entre autres données).

Pour plus d’informations, consultez : Charger et ajuster un fichier.

J’utilise une fonction edge Supabase, dois-je utiliser l’API directement ?

Nous recommandons d’utiliser la bibliothèque cliente Node.js de Mindee dans Supabase.

Vous pouvez l’installer dans votre/vos fonction(s) edge à l’aide de npm.

Quelles fonctionnalités de la bibliothèque sont officiellement prises en charge ?

Tout ce qui est documenté ici est officiellement pris en charge et considéré comme stable pour une utilisation en production.

Tout élément d’une bibliothèque qui n’est pas documenté ici est pas officiellement pris en charge et peut être modifié ou supprimé.

Il y a un bogue avec le SDK, comment puis-je obtenir de l’aide ?

Si vous rencontrez un problème persistant, vous devriez d’abord essayer :

1. Demander de l’aide à l’Assistant Docs :
2. Demander de l’aide à votre agent local en utilisant l’un de nos fichiers SKILL

Après cela, si vous déterminez (ou si l’on vous indique) qu’il y a un problème avec le SDK lui-même, le mieux serait d’ouvrir un rapport de bogue sur le dépôt GitHub du SDK concerné :

• Python: https://github.com/mindee/mindee-api-python/issues
• Node.js: https://github.com/mindee/mindee-api-nodejs/issues
• PHP: https://github.com/mindee/mindee-api-php/issues
• Ruby: https://github.com/mindee/mindee-api-ruby/issues
• Java: https://github.com/mindee/mindee-api-java/issues
• .NET: https://github.com/mindee/mindee-api-dotnet/issues

Nos ingénieurs SDK seront automatiquement informés du nouveau problème.

Remarque : Les forfaits Pro et supérieurs peuvent contacter directement nos équipes d’assistance.