Classification Quick Start

Integrate a Classification Model.

Install the Client Library

Install the Mindee SDK for your language or framework of choice

Python

Requires Python ≥ 3.10. Python ≥ 3.12 is recommended.

Simply install the PyPi package using pip:

pip install -U mindee~=5.3

Node.js

Requires Node.js ≥ 20.1. Node.js ≥ 22 is recommended.

Simply install the NPM package:

npm install mindee@^5.10.0

PHP

Requires PHP ≥ 8.1. PHP ≥ 8.3 is recommended.

Simply install the Packagist package using composer:

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

Ruby

Requires Ruby ≥ 3.2.

Simply install the gem using:

gem install mindee -v '~> 5.4'

Java

Requires Java ≥ 11. Java ≥ 17 is recommended.

Group ID: com.mindee.sdk Artifact ID: mindee-api-java Version: 5.5.0 or greater

There are various installation methods, Maven, Gradle, etc:

Installation Details

.NET

.NET ≥ 8.0 is recommended.

Simply install the NuGet package using dotnet add:

dotnet add package Mindee --version 4.8

Don't see support for your favorite language or framework? Make a feature request!

Send a File and Poll

Use the client library to send the file to your Classification Model and return the result.

Python

Requires Python ≥ 3.10. Python ≥ 3.12 is recommended. Requires the Mindee Python SDK version 5.3.1 or greater.

from mindee import PathInput
from mindee.v2 import (
    Client,
    ClassificationParameters,
    ClassificationResponse,
)

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

# Init a new client
mindee_client = Client(api_key)

# Set Classification parameters
model_params = ClassificationParameters(
    # ID of the model, required.
    model_id=model_id,
)

# Load a file from disk
input_source = PathInput(input_path)

# Send for processing using polling
response = mindee_client.enqueue_and_get_result(
    ClassificationResponse,
    input_source,
    model_params,
)

# Print a brief summary of the parsed data
print(response.inference)

# Access the classification result
classification: str = response.inference.result.classification.document_type

Also take a look at the Classification Result documentation.

Node.js

Requires Node.js ≥ 20.1. Node.js ≥ 22 is recommended. Requires the Mindee Node.js SDK version 5.10.0 or greater.

// ESM or TypeScript (Recommended)
import * as mindee from "mindee";

// If you're on CommonJS:
// const mindee = require("mindee");

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

// Init a new client
const mindeeClient = new mindee.Client(
  { apiKey: apiKey }
);

// Set Classification parameters
const modelParams = {
  modelId: modelId,
};

// Load a file from disk
const inputSource = new mindee.PathInput({ inputPath: filePath });

// Send for processing
const response = await mindeeClient.enqueueAndGetResult(
  mindee.product.Classification,
  inputSource,
  modelParams,
);

// print a string summary
console.log(response.inference.toString());

// Access the classification result
const classification = response.inference.result.classification;

Also take a look at the Classification Result documentation.

PHP

Requires PHP ≥ 8.1. PHP ≥ 8.3 is recommended. Requires the Mindee PHP SDK version 3.2.0 or greater.

<?php

use Mindee\Input\PathInput;
use Mindee\V2\Client;
use Mindee\V2\Product\Classification\Params\ClassificationParameters;
use Mindee\V2\Product\Classification\ClassificationResponse;

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

// Init a new client
$mindeeClient = new Client($apiKey);

// Set Classification parameters
$modelParams = new ClassificationParameters(
    // ID of the model, required.
    $modelId,
);

// Load a file from disk
$inputSource = new PathInput($filePath);

// Send for processing using polling
$response = $mindeeClient->enqueueAndGetResult(
    ClassificationResponse::class,
    $inputSource,
    $modelParams
);

// Print a summary of the response
echo strval($response->inference);

// Access the classification results
$classification = $response->inference->result->classification;

Also take a look at the Classification Result documentation.

Ruby

Requires Ruby ≥ 3.2. Requires the Mindee Ruby SDK version 5.4.0 or greater.

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

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

# Init a new client
mindee_client = Mindee::V2::Client.new(api_key: api_key)

# Set Classification parameters
model_params = {
    # ID of the model, required.
    model_id: model_id,
}

# Load a file from disk
input_source = Mindee::Input::Source::PathInputSource.new(input_path)

# Send for processing
response = mindee_client.enqueue_and_get_result(
    Mindee::V2::Product::Classification::Classification,
    input_source,
    model_params
)

# Access the classification result
puts response.inference.result.classification

Also take a look at the Classification Result documentation.

Java

Requires Java ≥ 11. Java ≥ 17 is recommended. Requires the Mindee Java SDK version 5.5.0 or greater.

import com.mindee.input.LocalInputSource;
import com.mindee.v2.MindeeClient;
import com.mindee.v2.product.classification.ClassificationResponse;
import com.mindee.v2.product.classification.params.ClassificationParameters;
import java.io.IOException;

public class SimpleMindeeClientV2 {

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

    // Init a new client
    var mindeeClient = new MindeeClient(apiKey);

    // Set Classification parameters
    var modelParams = ClassificationParameters
        // ID of the model, required.
        .builder(modelId)
        .build();

    // Load a file from disk
    var inputSource = new LocalInputSource(filePath);

    // Send for processing using polling
    ClassificationResponse response = mindeeClient.enqueueAndGetResult(
        ClassificationResponse.class,
        inputSource,
        modelParams
    );

    // Print a summary of the response
    System.out.println(response.getInference().toString());

    // Access the classification result
    var result = response.getInference().getResult();
    String documentType = result.getClassification().getDocumentType();
  }
}

Also take a look at the Classification Result documentation.

.NET

.NET ≥ 8.0 is recommended. Requires the Mindee .NET SDK version 4.8.1 or greater.

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

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

// Construct a new client
Client mindeeClient = new Client(apiKey);

// Set inference parameters
var modelParams = new ClassificationParameters(
    modelId: modelId
);

// Load a file from disk
var inputSource = new LocalInputSource(filePath);

// Upload the file
var response = await mindeeClient.EnqueueAndGetResultAsync<ClassificationResponse>(
    inputSource, modelParams);

// Print a summary of the response
System.Console.WriteLine(response.Inference.ToString());

// Access the classification results
var classification = response.Inference.Result.Classification;

Also take a look at the Classification Result documentation.