Recherche

Recherchez des ressources liées à votre organisation.

Utilisez la méthode générique de recherche dans le client pour trouver diverses ressources appartenant à votre organisation.

Avant de commencer

Vous aurez besoin d'une instance du Mindee V2 Client afin d'effectuer des requêtes de recherche.

Recherche de modèles

Recherchez des modèles au sein de l'organisation liée à la clé API.

Tous les filtres de recherche sont facultatifs. Si aucun filtre de recherche n'est fourni, tous les modèles appartenant à l'organisation sont renvoyés.

Python

from mindee.v2.search.models.model_search_response import ModelSearchResponse

search_params = ModelSearchParameters(
    # Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
    name="invoice",
    # Filtrer par un type de modèle exact.
    model_type="extraction",
)

response = client.search(search_params)

# afficher une représentation lisible de la réponse, utile pour le développement
print(str(response))

# accéder aux informations du modèle
for model in response.models:
    model_id = model.id

Node.js

import { ModelSearch } from "@/v2/search/index.js";

const searchParams = {
  // Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
  name: "invoice",
  // Filtrer par un type de modèle exact.
  modelType: "extraction"
};

const response = await client.search(ModelSearch, searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
console.log(response.toString());

// accéder aux informations du modèle
for (const model of response.models) {
  const modelId = model.id;
}

PHP

use Mindee\V2\Search\Models\ModelSearchParameters;

$searchParams = new ModelSearchParameters(
    // Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
    name: "invoice",
    // Filtrer par un type de modèle exact.
    modelType: "extraction",
);

$response = $client->search($searchParams);

// Afficher une représentation lisible de la réponse, utile pour le développement
print_r($response);

// Accéder aux informations du modèle
foreach ($response->models as $model) {
    $modelId = $model->id;
}

Ruby

require 'mindee'

search_params = Mindee::V2::Search::Models::ModelSearchParameters.new(
    # Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
    name: 'invoice',
    # Filtrer par un type de modèle exact.
    model_type: 'extraction',
)

response = client.search(search_params)

# afficher une représentation lisible de la réponse, utile pour le développement
puts response.to_s

# accéder aux informations du modèle
response.models.each do |model|
  model_id = model.id
end

Java

import com.mindee.v2.search.models.ModelSearchParameters;

var searchParams = new ModelSearchParameters.builder()
    // Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
    .name("invoice")
    // Filtrer par un type de modèle exact.
    .modelType("extraction")
    .build();

var response = client.search(searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
System.out.println(response.toString());

// accéder aux informations du modèle
for (var model : response.getModels()) {
    String modelId = model.getId();
}

.NET

using Mindee.V2.Search.Models;

var searchParams = new ModelSearchParameters(
    // Filtrer les modèles par correspondance partielle du nom, sans tenir compte de la casse.
    name: 'invoice',
    // Filtrer par un type de modèle exact.
    modelType: 'extraction'
);

var response = await client.SearchAsync(searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
Console.WriteLine(response.ToString());

// accéder aux informations du modèle
foreach (var model in response.Models)
{
    string modelId = model.Id;
}

Recherche de documents RAG

Recherchez des documents RAG au sein de l'organisation liée à la clé API.

L'ID de modèle est requis, les filtres de recherche sont facultatifs. Si aucun filtre de recherche n'est fourni, tous les documents liés au modèle sont renvoyés.

Python

from mindee.v2.search.rag_documents.rag_document_search_parameters import (
    RagDocumentSearchParameters,
)

search_params = RagDocumentSearchParameters(
    # L'UUID exact du modèle auquel le document est associé.
    model_id="my-model-uuid",
    # Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
    filename="invoice_32GB-RAM_450k-USD.pdf",
)

response = client.search(search_params)

# afficher une représentation lisible de la réponse, utile pour le développement
print(str(response))

# accéder aux informations du document RAG
for rag_doc in response.rag_documents:
    rag_doc_id = rag_doc.id
    rag_doc_total_matches = rag_doc.total_matches

Node.js

import { RagDocumentSearch } from "@/v2/search/index.js";

const searchParams = {
  // L'UUID exact du modèle auquel le document est associé.
  modelId: "my-model-uuid",
  // Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
  filename: "invoice_32GB-RAM_450k-USD.pdf"
};

const response = await client.search(RagDocumentSearch, searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
console.log(response.toString());

// accéder aux informations du document RAG
for (const ragDoc of response.ragDocuments) {
  const ragDocId = ragDoc.id;
  const ragDocTotalMatches = ragDoc.totalMatches;
}

PHP

use Mindee\V2\Search\RagDocuments\RagDocumentSearchParameters;

$searchParams = new RagDocumentSearchParameters(
    // L'UUID exact du modèle auquel le document est associé.
    modelId: "my-model-uuid",
    // Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
    filename: "invoice_32GB-RAM_450k-USD.pdf",
);

$response = $client->search($searchParams);

// Afficher une représentation lisible de la réponse, utile pour le développement
print_r($response);

// Accéder aux informations du document RAG
foreach ($response->ragDocuments as $ragDoc) {
    $ragDocId = $ragDoc->id;
    $ragDocTotalMatches = $ragDoc->totalMatches;
}

Ruby

require 'mindee'

search_params = Mindee::V2::Search::RagDocuments::RagDocumentSearchParameters.new(
  # L'UUID exact du modèle auquel le document est associé.
  model_id: 'my-model-uuid',
  # Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
  filename: 'invoice_32GB-RAM_450k-USD.pdf',
)

response = client.search(search_params)

# afficher une représentation lisible de la réponse, utile pour le développement
puts response.to_s

# accéder aux informations du document RAG
response.rag_documents.each do |rag_doc|
  rag_doc_id = rag_doc.id
  rag_doc_total_matches = rag_doc.total_matches
end

Java

import com.mindee.v2.search.ragdocuments.RagDocumentSearchParameters;

var searchParams = new RagDocumentSearchParameters.builder()
        // L'UUID exact du modèle auquel le document est associé.
        .modelId("my-model-uuid")
        // Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
        .filename("invoice_32GB-RAM_450k-USD.pdf")
        .build();

var response = client.search(searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
System.out.println(response.toString());

// accéder aux informations du document RAG
for (var ragDoc : response.getRagDocuments()) {
    String ragDocId = ragDoc.getId();
    int ragDocTotalMatches = ragDoc.getTotalMatches();
}

.NET

using Mindee.V2.Search.RagDocuments;

var searchParams = new RagDocumentSearchParameters(
    // L'UUID exact du modèle auquel le document est associé.
    modelId: "my-model-uuid",
    // Filtrer les documents par correspondance partielle du nom de fichier, sans tenir compte de la casse.
    filename: "invoice_32GB-RAM_450k-USD.pdf"
);

var response = await client.SearchAsync(searchParams);

// afficher une représentation lisible de la réponse, utile pour le développement
Console.WriteLine(response.ToString());

// accéder aux informations du document RAG
foreach (var ragDoc in response.RagDocuments)
{
    string ragDocId = ragDoc.Id;
    int ragDocTotalMatches = ragDoc.TotalMatches;
}