Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt

Use this file to discover all available pages before exploring further.

Réorganisez les documents à l’aide de modèles de similitude sémantique. Utile pour améliorer les résultats de recherche et les applications RAG.

​
Corps de la requête

Timeout des requêtes synchrones : cet endpoint non-chat attend que le modèle routé termine son traitement. Les entrées volumineuses, les longs fichiers audio ou les grands lots peuvent dépasser les valeurs par défaut courantes de 30s côté client ; configurez donc le timeout de votre client HTTP à au moins 120s.
​
model
string
requis
ID du modèle de reranker à utiliser (par ex., BAAI/bge-reranker-v2-m3, qwen3-rerank).
​
query
string
requis
La requête par rapport à laquelle classer les documents. Longueur maximale : 32,000 caractères.
​
documents
array
requis
Liste de documents (chaînes de caractères) à réorganiser. Limites : jusqu’à 1,000 documents, chaque document jusqu’à 100,000 caractères, et au plus 2,000,000 caractères de documents au total.
​
top_n
integer
Nombre de meilleurs résultats à retourner. Par défaut, tous les documents. Doit être au moins 1 et ne pas dépasser documents.length. TokenLab n’a actuellement aucun hard cap inférieur spécifique à un fournisseur sous gouvernance ; si un fournisseur en publie un plus tard, il devra d’abord être ajouté à la truth de request-shape rerank avant d’être documenté ou appliqué.
​
return_documents
boolean
défaut:"false"
Indique s’il faut inclure le texte original du document dans la réponse.

​
Réponse

​
results
array
Liste classée des documents avec scores.Chaque résultat contient :
  • index (integer) : Index du document original
  • relevance_score (number) : Score de pertinence (0-1)
  • document (string) : Texte original (si return_documents=true)
​
model
string
Le modèle utilisé pour la réorganisation.
​
usage
object
Statistiques d’utilisation des tokens.
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-reranker-v2-m3",
    "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
  }'

{
  "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": "BAAI/bge-reranker-v2-m3",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}