Endpunkte
Rerank
POST /rerank sortiert Dokumente nach Relevanz zu einer Suchanfrage und liefert Scores, ideal als zweite Stufe einer Suchpipeline oder von RAG.
Im Playground testenSortieren Sie eine Liste von Dokumenten nach Relevanz zu einer Suchanfrage. Reranker sind die zweite Stufe einer Suchpipeline: Holen Sie 50 bis 200 Kandidaten mit Embeddings oder Stichwortsuche, ranken Sie sie dann neu und behalten Sie die besten für Ihren Prompt.
POST https://api14.com/api/v1/rerank
Die offiziellen OpenAI-SDKs haben keine Rerank-Methode, rufen Sie den Endpunkt also per einfachem HTTP auf (jedes Sprachbeispiel unten tut das).
Anfrage
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
model | string | ja | Eine Rerank-Modell-ID, z. B. cohere/rerank-v3.5. |
query | string | ja | Die Suchanfrage. |
documents | string[] | ja | Kandidatentexte, die bewertet werden sollen. |
top_n | integer | nein | Nur die besten N Ergebnisse zurückgeben. Standard: alle. |
return_documents | boolean | nein | Den Dokumenttext in jedes Ergebnis aufnehmen. |
Beispiel
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
}'
Antwort
{
"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 verweist auf Ihr documents-Array. Die Ergebnisse sind nach relevance_score sortiert, das höchste zuerst.
Preise
Rerank-Modelle werden pro Suche zum gelisteten Preis des Modells abgerechnet, angezeigt als "$ / 1K Suchen". Die Kosten stehen in usage.cost und werden von Ihrem USD-Guthaben abgebucht.
Rerank-Modelle auflisten
curl "https://api14.com/api/v1/models?category=rerank"
Fehler
| Status | Code | Wann |
|---|---|---|
| 400 | model_required / invalid_json | model fehlt oder der Body ist fehlerhaft. |
| 402 | insufficient_balance | Ihr USD-Guthaben beträgt 0 $. |
| 403 | model_not_allowed | Die Allowlist des Schlüssels schließt das Modell aus. |
| 404 | model_not_found | Unbekannte oder deaktivierte Modell-ID. |
| 429 | rate_limited | Anfragen pro Minute überschritten. |
Siehe Fehler.