Endpoint
Rerank
Ordina i documenti per rilevanza rispetto a una query con POST /rerank, come secondo stadio di una pipeline di ricerca, con parametri, risposta e costi.
Provalo nel playgroundOrdina un elenco di documenti per rilevanza rispetto a una query. I reranker sono il secondo stadio di una pipeline di ricerca: recupera 50-200 candidati con gli embeddings o con la ricerca per parole chiave, poi riordinali e tieni i primi pochi per il tuo prompt.
POST https://api14.com/api/v1/rerank
Gli SDK ufficiali di OpenAI non hanno un metodo rerank, quindi chiamalo con HTTP semplice (lo fanno tutti gli esempi per linguaggio qui sotto).
Richiesta
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
model | string | sì | L'id di un modello rerank, ad es. cohere/rerank-v3.5. |
query | string | sì | La query di ricerca. |
documents | string[] | sì | Testi candidati da valutare. |
top_n | integer | no | Restituisce solo i migliori N risultati. Per impostazione predefinita restituisce tutti. |
return_documents | boolean | no | Include il testo del documento in ogni risultato. |
Esempio
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
}'
Risposta
{
"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 punta all'interno del tuo array documents. I risultati sono ordinati per relevance_score, dal più alto.
Prezzi
I modelli rerank sono fatturati per ricerca al prezzo indicato per il modello, mostrato come "$ / 1K ricerche". Il costo è in usage.cost e viene scalato dal tuo saldo in USD.
Elencare i modelli rerank
curl "https://api14.com/api/v1/models?category=rerank"
Errori
| Stato | Codice | Quando |
|---|---|---|
| 400 | model_required / invalid_json | Manca model oppure il corpo è malformato. |
| 402 | insufficient_balance | Il tuo saldo in USD è $0. |
| 403 | model_not_allowed | La lista dei modelli consentiti della chiave esclude il modello. |
| 404 | model_not_found | Id del modello sconosciuto o disattivato. |
| 429 | rate_limited | Superato il limite di richieste al minuto. |
Vedi Errori.