Endpoints
Rerank
POST /rerank: sorteer documenten op relevantie voor een zoekopdracht, als tweede stap in een zoekpipeline of RAG-systeem.
Probeer het in de playgroundSorteer een lijst documenten op relevantie voor een zoekopdracht. Rerankers vormen de tweede fase van een zoekpipeline: haal 50 tot 200 kandidaten op met embeddings of zoeken op trefwoorden, rerank ze en houd de beste paar over voor je prompt.
POST https://api14.com/api/v1/rerank
De officiële OpenAI-SDK's hebben geen rerank-methode, dus roep het aan met gewone HTTP (elk taalvoorbeeld hieronder doet dat).
Request
| Parameter | Type | Verplicht | Beschrijving |
|---|---|---|---|
model | string | ja | Een rerankmodel-id, bijv. cohere/rerank-v3.5. |
query | string | ja | De zoekopdracht. |
documents | string[] | ja | Kandidaatteksten die gescoord moeten worden. |
top_n | integer | nee | Geef alleen de beste N resultaten terug. Standaard alle. |
return_documents | boolean | nee | Neem de documenttekst op in elk resultaat. |
Voorbeeld
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
}'
Response
{
"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 wijst naar je documents-array. Resultaten zijn gesorteerd op relevance_score, hoogste eerst.
Prijzen
Rerankmodellen worden per zoekopdracht gefactureerd tegen de vermelde prijs van het model, getoond als "$ / 1K zoekopdrachten". De kosten staan in usage.cost en worden van je USD-saldo afgeschreven.
Rerankmodellen weergeven
curl "https://api14.com/api/v1/models?category=rerank"
Fouten
| Status | Code | Wanneer |
|---|---|---|
| 400 | model_required / invalid_json | model ontbreekt of de body is ongeldig. |
| 402 | insufficient_balance | Je USD-saldo is $0. |
| 403 | model_not_allowed | De allowlist van de key sluit het model uit. |
| 404 | model_not_found | Onbekend of uitgeschakeld model-id. |
| 429 | rate_limited | Requests per minuut overschreden. |
Zie Fouten.