Référence API
Rerank
Reclassez les documents candidats selon leur pertinence par rapport à la requête.
L'API Rerank prend une requête et des documents candidats, puis renvoie des résultats classés par pertinence. Elle est couramment utilisée après la récupération dans les pipelines RAG.
Point de terminaison
| Méthode | Chemin | Description |
|---|---|---|
POST | /v1/rerank | Reclasser les documents candidats |
Champs de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
model | string | Oui | ID du modèle de reranking |
query | string | Oui | Texte de la requête |
documents | array | Oui | Documents candidats, sous forme de chaînes ou d'objets |
top_n | integer | Non | Renvoyer les N meilleurs résultats |
return_documents | boolean | Non | Inclure le document original dans chaque résultat, par défaut false |
max_chunk_per_doc | integer | Non | Nombre maximal de blocs par document, selon la prise en charge du canal |
overlap_tokens | integer | Non | Nombre de tokens de chevauchement entre blocs, selon la prise en charge du canal |
curl
curl https://api.tensoraxis.com/v1/rerank \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TENSORAXIS_API_KEY" \
-d '{
"model": "jina-reranker-v2-base-multilingual",
"query": "What is an API gateway?",
"documents": [
"An API gateway handles authentication, routing and rate limiting.",
"A vector database is used for similarity search.",
"Object storage stores files."
],
"top_n": 2,
"return_documents": true
}'Forme de la réponse
{
"results": [
{
"index": 0,
"relevance_score": 0.98,
"document": "An API gateway handles authentication, routing and rate limiting."
}
],
"usage": {
"total_tokens": 42
}
}Lorsque return_documents vaut false, les résultats n'incluent généralement que index et relevance_score.