Endpoints
Rerank
POST /rerank : classez des documents par pertinence par rapport à une requête, en seconde étape d'un pipeline de recherche ou de RAG.
Essayer dans le playgroundClassez une liste de documents par pertinence par rapport à une requête. Les rerankers sont la seconde étape d'un pipeline de recherche : récupérez 50 à 200 candidats avec des embeddings ou une recherche par mots-clés, puis reclassez et gardez les meilleurs pour votre prompt.
POST https://api14.com/api/v1/rerank
Les SDK officiels d'OpenAI n'ont pas de méthode rerank : appelez-le donc en HTTP simple (chaque exemple de langage ci-dessous le fait).
Requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
model | string | oui | Un identifiant de modèle de rerank, par ex. cohere/rerank-v3.5. |
query | string | oui | La requête de recherche. |
documents | string[] | oui | Textes candidats à noter. |
top_n | integer | non | Ne renvoie que les N meilleurs résultats. Tous par défaut. |
return_documents | boolean | non | Inclut le texte du document dans chaque résultat. |
Exemple
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api14.com/api/v1",
apiKey: process.env.API14_API_KEY,
});
const result = await client.post("/rerank", { body: {
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"documents": [
"Paris is the capital of France.",
"Berlin is in Germany."
],
"top_n": 1
} });
console.log(result.results);
curl https://api14.com/api/v1/rerank \
-H "Authorization: Bearer sk-api14-..." \
-H "Content-Type: application/json" \
-d '{
"model": "cohere/rerank-v3.5",
"query": "How do I reset my password?",
"documents": [
"Billing happens on the first of each month.",
"To reset your password, open Settings and choose Security.",
"Our office is closed on public holidays."
],
"top_n": 2
}'
Réponse
{
"id": "gen-1791100000-rr1",
"model": "cohere/rerank-v3.5",
"results": [
{ "index": 1, "relevance_score": 0.94 },
{ "index": 0, "relevance_score": 0.08 }
],
"usage": { "search_units": 1, "cost": 0.002 }
}
index renvoie à la position dans votre tableau documents. Les résultats sont triés par relevance_score, du plus élevé au plus bas.
Tarifs
Les modèles de rerank sont facturés par recherche au prix indiqué du modèle, affiché en « $ / 1K recherches ». Le coût figure dans usage.cost et est débité de votre solde en USD.
Lister les modèles de rerank
curl "https://api14.com/api/v1/models?category=rerank"
Erreurs
| Statut | Code | Quand |
|---|---|---|
| 400 | model_required / invalid_json | model manquant ou corps mal formé. |
| 402 | insufficient_balance | Votre solde en USD est à 0 $. |
| 403 | model_not_allowed | La liste autorisée de la clé exclut le modèle. |
| 404 | model_not_found | Identifiant de modèle inconnu ou désactivé. |
| 429 | rate_limited | Requêtes par minute dépassées. |
Voir Erreurs.