TokenLab

Texte

Rerank Documents

Réordonne les documents en fonction de leur pertinence par rapport à une requête

POST
/v1/rerank

Utilisez GET /v1/models?recommended_for=rerank pour lister les modèles de rerank actuels. Utilisez un modèle dont les détails mentionnent l'opération rerank.

Réordonnez des documents en utilisant des modèles de similarité sémantique. Utile pour améliorer les résultats de recherche et les applications RAG.

Corps de la requête

Ce endpoint renvoie une réponse une fois le classement terminé. Pour les grands ensembles de documents, réglez le délai d'attente (timeout) de votre client HTTP sur au moins 120s.

modelstringrequis

ID du modèle de reranker à utiliser (par ex. qwen3-vl-rerank).

querystringrequis

La requête par rapport à laquelle classer les documents. Longueur maximale : 32,000 caractères.

documentsarrayrequis

Liste des documents (chaînes de caractères) à réordonner. Limites : jusqu'à 1,000 documents, chaque document pouvant contenir jusqu'à 100,000 caractères, et au maximum 2,000,000 de caractères au total pour l'ensemble des documents.

top_ninteger

Nombre de meilleurs résultats à renvoyer, de 1 à documents.length. Si omis, le modèle sélectionné détermine le nombre de résultats.

return_documentsbooleanpar défaut: false

Indique s'il faut inclure le texte original du document dans chaque résultat. À envoyer uniquement lorsque les détails du modèle mentionnent return_documents.

Réponse

resultsarray

Liste classée des documents avec leurs scores.

Chaque résultat contient :

  • index (integer) : Index du document original
  • relevance_score (number) : Score de pertinence. Sa plage dépend du modèle sélectionné.
  • document (string) : Texte original (si return_documents=true)
modelstring

Le modèle utilisé pour le reranking. Lorsqu'il est disponible.

usageobject

Utilisation signalée pour la requête, lorsqu'elle est disponible : total_tokens, ou search_units pour les modèles facturés par recherche.

Requête

curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen3-vl-rerank",
    "query": "What is machine learning?",
    "documents": [
      "Machine learning is a subset of AI",
      "The weather is nice today",
      "Deep learning uses neural networks"
    ],
    "top_n": 2,
    "return_documents": true
  }'

Réponse

Response
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "Machine learning is a subset of AI"
    },
    {
      "index": 2,
      "relevance_score": 0.82,
      "document": "Deep learning uses neural networks"
    }
  ],
  "model": "qwen3-vl-rerank",
  "usage": {
    "total_tokens": 45
  }
}

Erreurs

StatutCodeCause
400invalid_requestUn champ est manquant, vide ou dépasse une limite ci-dessus. param le désigne
400unsupported_endpointLe modèle n'est pas publié pour ce endpoint

Gérez les autres statuts comme indiqué dans Gérer les erreurs API.

Autorisation

BearerAuth
AuthorizationBearer <token>

Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.

Emplacement: header

En-têtes

X-TokenLab-Delivery-Policy?string

Politique de livraison par requête. Remplace les valeurs par défaut de la clé API et de l'espace de travail. Tente automatiquement TokenLab Verified en premier et peut basculer une fois vers Official uniquement avant la sortie, l'acceptation de la requête ou la création de ressource persistante.

Valeurs possibles

  • "auto"
  • "verified"
  • "official"

Corps de la requête

application/json

Réponse

application/json

application/json

application/json

application/json

application/json

application/json

application/json