Configuration du client

Documentation de référence sur la préparation et la configuration du client Mindee.

Il s'agit d'une documentation de référence.

Les exemples de code affichés sont uniquement des exemples et ne fonctionneront pas tels quels. Vous devrez les copier-coller et les modifier selon vos besoins.

Vous cherchez des exemples de code complets ?

Vous pouvez également utiliser le bouton « Demander » en haut de n'importe quelle page de la documentation.

Avant de commencer

Vous devez disposer de l'un des SDK officiels de Mindee installés.

Vous devrez également utiliser l'une de vos clés API et avoir au moins un Model configuré.

Le client fonctionne pour tous les types de Model.

Initialiser le client Mindee

Avant d'envoyer des fichiers aux serveurs Mindee pour traitement, vous devez initialiser votre client.

Ceci doit être la première étape de votre code. Cela déterminera quelle organisation est utilisée pour effectuer les appels.

Vous devez réutiliser la même instance du client pour tous les appels de la même organisation.

L'instance du client est thread-safe dans les langages concernés.

Python

Importez d'abord les classes nécessaires :

from mindee.v2 import Client

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

api_key = "MY_API_KEY"

mindee_client = Client(api_key)

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MINDEE_V2_API_KEY

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le api_key lors de l'initialisation du client.

mindee_client = Client()

Node.js

Importez d'abord les classes nécessaires. Nous recommandons d'utiliser les ES Modules.

import * as mindee from "mindee";
// Si vous utilisez CommonJS :
// const mindee = require("mindee");

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

const apiKey = "MY_API_KEY";

const mindeeClient = new mindee.Client({ apiKey: apiKey });

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MINDEE_V2_API_KEY

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le apiKey argument lors de l'initialisation du client.

const mindeeClient = new mindee.Client();

Utilisation avancée

en interne, undici est utilisé pour effectuer les appels HTTP, et lorsque le client est initialisé getGlobalDispatcher est appelé.

Cela convient parfaitement à la grande majorité des cas : Si vous définissez un Agent personnalisé comme dispatcher global, Mindee l'utilisera pour tous les appels.

Dans certains rares cas, vous pouvez avoir besoin d'un dispatcher spécifique pour Mindee, différent de votre dispatcher global. Vous pouvez définir un dispatcher personnalisé comme suit :

import { Agent, interceptors } from "undici";

// Initialisez le Dispatcher personnalisé
// REMPLACEZ LA LIGNE CI-DESSOUS PAR VOTRE CODE - cet exemple ne fonctionnera PAS !
const myDispatcher = new Agent().compose( ... );

const mindeeClient = new mindee.Client({
  // Ne pas définir si vous utilisez une variable d'environnement
  apiKey: apiKey,

  // Active la journalisation détaillée - désactivez en production !
  debug: true,

  // Passe le dispatcher personnalisé au client Mindee
  dispatcher: myDispatcher,
});

Le client Mindee utilisera alors le dispatcher fourni pour tous les appels.

Ceci est la configuration recommandée lorsque vous devez transmettre des paramètres supplémentaires ou des options de configuration, par exemple lorsque vous utilisez le Client derrière un proxy.

Lors de l'exécution dans certains environnements serverless comme Vercel, parfois (cela dépend de votre configuration exacte), des erreurs sont causées par le gel/dégel du processus. Celles-ci peuvent être évitées en :

// Évite l'accumulation de connexions obsolètes dans le pool.
const myDispatcher = new Agent({
  // Supprime les sockets inactifs après 1 ms, ce qui désactive effectivement la réutilisation des connexions
  keepAliveTimeout: 1,
  // Empêche le serveur d'étendre la fenêtre via un en-tête Keep-Alive
  keepAliveMaxTimeout: 1,
});

PHP

Importez d'abord les classes nécessaires :

use Mindee\\V2\\Client;

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

$apiKey = "MY_API_KEY";

$mindeeClient = new Client($apiKey);

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MINDEE_V2_API_KEY

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le $apiKey lors de l'initialisation du client.

$mindeeClient = new Client($apiKey);

Ruby

Importez d'abord le package Mindee :

require 'mindee'

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

api_key = 'MY_API_KEY'
mindee_client = Mindee::V2::Client.new(api_key: api_key)

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MINDEE_V2_API_KEY

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le api_key lors de l'initialisation du client.

mindee_client = Mindee::V2::Client.new()

Java

Importez d'abord les classes nécessaires :

import com.mindee.v2.MindeeClient;

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

String apiKey = "MY_API_KEY";

MindeeClient mindeeClient = new MindeeClient(apiKey);

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MINDEE_V2_API_KEY

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le apiKey argument lors de l'initialisation du client.

MindeeClient mindeeClient = new MindeeClient();

.NET

Ajoutez d'abord les espaces de noms requis.

using Mindee.V2;

Pour la clé API, vous pouvez la transmettre directement au client. C'est utile pour des tests rapides.

string apiKey = "MY_API_KEY";

Client mindeeClient = new Client(apiKey);

Au lieu de transmettre la clé directement, vous pouvez également définir la variable d'environnement suivante :

MindeeV2__ApiKey

Ceci est recommandé pour une utilisation en production. De cette façon, il n'est pas nécessaire de transmettre le apiKey argument lors de l'initialisation du client.

Client mindeeClient = new Client();