Endpoints
Rerank
Ordena documentos por relevancia respecto a una consulta con POST /rerank, la segunda etapa de un flujo de búsqueda o de RAG.
Pruébalo en el playgroundOrdena una lista de documentos por relevancia respecto a una consulta. Los rerankers son la segunda etapa de un flujo de búsqueda: recupera de 50 a 200 candidatos con embeddings o búsqueda por palabras clave, y luego reordénalos y quédate con unos pocos para tu prompt.
POST https://api14.com/api/v1/rerank
Los SDK oficiales de OpenAI no tienen un método de rerank, así que llámalo con HTTP simple (todos los ejemplos de lenguaje siguientes lo hacen).
Petición
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
model | string | sí | Un id de modelo de rerank, p. ej. cohere/rerank-v3.5. |
query | string | sí | La consulta de búsqueda. |
documents | string[] | sí | Textos candidatos que se puntuarán. |
top_n | integer | no | Devuelve solo los N mejores resultados. Por defecto, todos. |
return_documents | boolean | no | Incluye el texto del documento en cada resultado. |
Ejemplo
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
}'
Respuesta
{
"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 apunta a tu array documents. Los resultados se ordenan por relevance_score, de mayor a menor.
Precios
Los modelos de rerank se facturan por búsqueda al precio indicado del modelo, mostrado como "$ / 1K búsquedas". El coste está en usage.cost y se descuenta de tu saldo en USD.
Listar modelos de rerank
curl "https://api14.com/api/v1/models?category=rerank"
Errores
| Estado | Código | Cuándo |
|---|---|---|
| 400 | model_required / invalid_json | Falta model o el cuerpo está mal formado. |
| 402 | insufficient_balance | Tu saldo en USD es $0. |
| 403 | model_not_allowed | La lista de modelos permitidos de la clave excluye el modelo. |
| 404 | model_not_found | Id de modelo desconocido o desactivado. |
| 429 | rate_limited | Se superaron las peticiones por minuto. |
Consulta Errores.