Démarrage rapide OCR

Intégrez un modèle OCR.

Installer la bibliothèque cliente

Installez la bibliothèque cliente Mindee pour votre langage ou framework de choix

Python

Nécessite Python ≥ 3.10. Python ≥ 3.12 est recommandé.

Installez simplement le package PyPI à l'aide de pip:

pip install -U mindee~=5.3

Node.js

Nécessite Node.js ≥ 20.1. Node.js ≥ 22 est recommandé.

Installez simplement le package NPM:

npm install mindee@^5.10.0

PHP

Nécessite PHP ≥ 8.1. PHP ≥ 8.3 est recommandé.

Installez simplement le package Packagist à l'aide de composer:

php composer.phar require "mindee/mindee:>=3.2"

Ruby

Nécessite Ruby ≥ 3.2.

Installez simplement le gem avec :

gem install mindee -v '~> 5.4'

Java

Nécessite Java ≥ 11. Java ≥ 17 est recommandé.

ID du groupe : com.mindee.sdk ID de l'artefact : mindee-api-java Version : 5.5.0 ou plus

Il existe diverses méthodes d'installation, Maven, Gradle, etc. :

Détails de l'installation

.NET

.NET ≥ 8.0 est recommandé.

Installez simplement le package NuGet à l'aide de dotnet add:

dotnet add package Mindee --version 4.8

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

Envoyer un fichier et interroger

Utilisez la bibliothèque cliente pour envoyer le fichier à votre modèle de texte brut (OCR) et renvoyer le résultat.

Python

Nécessite Python ≥ 3.10. Python ≥ 3.12 est recommandé. Nécessite le Mindee Python SDK version 5.3.1 ou supérieure.

from mindee import PathInput
from mindee.v2 import (
    Client,
    OCRParameters,
    OCRResponse,
)

input_path = "/path/to/the/file.ext"
api_key = "MY_API_KEY"
model_id = "MY_MODEL_ID"

# Initialiser un nouveau client
mindee_client = Client(api_key)

# Définir les paramètres Raw OCR
model_params = OCRParameters(
    # ID du modèle, requis.
    model_id=model_id,
)

# Charger un fichier depuis le disque
input_source = PathInput(input_path)

# Envoyer pour traitement en utilisant le polling
response = mindee_client.enqueue_and_get_result(
    OCRResponse,
    input_source,
    model_params,
)

# Afficher un bref résumé des données analysées
print(response.inference)

# Accéder au résultat OCR
pages: list = response.inference.result.pages

Consultez également la Résultat OCR documentation.

Node.js

Nécessite Node.js ≥ 20.1. Node.js ≥ 22 est recommandé. Nécessite le SDK Node.js de Mindee version 5.10.0 ou supérieure.

// ESM ou TypeScript (recommandé)
import * as mindee from "mindee";

// Si vous utilisez CommonJS :
// const mindee = require("mindee");

const apiKey = "MY_API_KEY";
const model_id = "MY_MODEL_ID";
const filePath = "/path/to/the/file.ext";

// Initialiser un nouveau client
const mindeeClient = new mindee.Client(
  { apiKey: apiKey }
);

// Définir les paramètres OCR bruts
const modelParams = {
  model_id: model_id,
};

// Charger un fichier depuis le disque
const inputSource = new mindee.PathInput({ inputPath: filePath });

// Envoyer pour traitement
const response = await mindeeClient.enqueueAndGetResult(
  mindee.product.Ocr,
  inputSource,
  modelParams,
);

// afficher un résumé sous forme de chaîne
console.log(response.inference.toString());

// Accéder aux pages du résultat OCR
const pages = response.inference.result.pages;

Consultez également la Résultat OCR documentation.

PHP

Nécessite PHP ≥ 8.1. PHP ≥ 8.3 est recommandé. Nécessite le Mindee PHP SDK version 3.2.0 ou supérieure.

<?php

use Mindee\Input\PathInput;
use Mindee\V2\Client;
use Mindee\V2\Product\Ocr\Params\OcrParameters;
use Mindee\V2\Product\Ocr\OcrResponse;

$apiKey = "MY_API_KEY";
$modelId = "MY_MODEL_ID";
$filePath = "/path/to/the/file.ext";

// Initialiser un nouveau client
$mindeeClient = new Client($apiKey);

// Définir les paramètres OCR bruts
$modelParams = new OcrParameters(
    // ID du modèle, requis.
    $modelId,
);

// Charger un fichier depuis le disque
$inputSource = new PathInput($filePath);

// Envoyer pour traitement à l'aide du polling
$response = $mindeeClient->enqueueAndGetResult(
    OcrResponse::class,
    $inputSource,
    $modelParams
);

// Afficher un résumé de la réponse
echo strval($response->inference);

// Accéder aux résultats OCR
$pages = $response->inference->result->pages;

Consultez également la Résultat OCR documentation.

Ruby

Nécessite Ruby ≥ 3.2. Nécessite le SDK Ruby de Mindee version 5.4.0 ou supérieure.

require 'mindee'
require 'mindee/v2/product'

input_path = '/path/to/the/file.ext'
api_key = 'MY_API_KEY'
model_id = 'MY_MODEL_ID'

# Initialisez un nouveau client
mindee_client = Mindee::V2::Client.new(api_key: api_key)

# Définissez les paramètres OCR bruts
model_params = {
    # ID du modèle, requis.
    model_id: model_id,
}

# Chargez un fichier depuis le disque
input_source = Mindee::Input::Source::PathInputSource.new(input_path)

# Envoyez pour traitement
response = mindee_client.enqueue_and_get_result(
    Mindee::V2::Product::OCR::OCR,
    input_source,
    model_params
)

# Accédez aux pages du résultat OCR
puts response.inference.result.pages

Consultez également la Résultat OCR documentation.

Java

Nécessite Java ≥ 11. Java ≥ 17 est recommandé. Nécessite la Mindee Java SDK version 5.5.0 ou supérieure.

import com.mindee.input.LocalInputSource;
import com.mindee.v2.MindeeClient;
import com.mindee.v2.product.ocr.OcrResponse;
import com.mindee.v2.product.ocr.params.OcrParameters;
import java.io.IOException;

public class SimpleMindeeClientV2 {

  public static void main(String[] args)
      throws IOException, InterruptedException
  {
    String apiKey = "MY_API_KEY";
    String filePath = "/path/to/the/file.ext";
    String modelId = "MY_MODEL_ID";

    // Initialisez un nouveau client
    var mindeeClient = new MindeeClient(apiKey);

    // Définissez les paramètres OCR bruts
    var modelParams = OcrParameters
        // ID du modèle, requis.
        .builder(modelId)
        .build();

    // Chargez un fichier depuis le disque
    var inputSource = new LocalInputSource(filePath);

    // Envoyez pour traitement en utilisant le polling
    OcrResponse response = mindeeClient.enqueueAndGetResult(
        OcrResponse.class,
        inputSource,
        modelParams
    );

    // Affichez un résumé de la réponse
    System.out.println(response.getInference().toString());

    // Accédez aux pages du résultat OCR
    var pages = response.getInference().getResult().getPages();
  }
}

Consultez également le Résultat OCR documentation.

.NET

.NET ≥ 8.0 est recommandé. Nécessite le Mindee .NET SDK version 4.8.1 ou plus.

using Mindee;
using Mindee.Input;
using Mindee.V2;
using Mindee.V2.Product.Ocr;
using Mindee.V2.Product.Ocr.Params;

string filePath = "/path/to/the/file.ext";
string apiKey = "MY_API_KEY";
string modelId = "MY_MODEL_ID";

// Créer un nouveau client
Client mindeeClient = new Client(apiKey);

// Définir les paramètres OCR bruts
var modelParams = new OcrParameters(
    modelId: modelId
);

// Charger un fichier depuis le disque
var inputSource = new LocalInputSource(filePath);

// Téléverser le fichier
var response = await mindeeClient.EnqueueAndGetResultAsync<OcrResponse>(
    inputSource, modelParams);

// Afficher un résumé de la réponse
System.Console.WriteLine(response.Inference.ToString());

// Accéder aux pages du résultat OCR
var ocrPages = response.Inference.Result.Pages;

Consultez également la Résultat OCR documentation.