Usamos cookies. Cookies e o armazenamento do navegador mantêm você conectado e lembram suas preferências. Com sua permissão, também medimos como o site é usado. Você pode a qualquer momento. Veja nossa política de cookies.

Rerank

Endpoints

Rerank

Ordene documentos por relevância para uma consulta com o endpoint POST /rerank do api14, com exemplo, resposta, preços e erros.

Teste no playground

Ordene uma lista de documentos por relevância para uma consulta. Os rerankers são a segunda etapa de um pipeline de busca: recupere de 50–200 candidatos com embeddings ou busca por palavras-chave, depois reordene e mantenha apenas os melhores para o seu prompt.

POST https://api14.com/api/v1/rerank

Os SDKs oficiais da OpenAI não têm um método de rerank, então chame o endpoint com HTTP simples (todos os exemplos de linguagem abaixo fazem isso).

Requisição

ParâmetroTipoObrigatórioDescrição
modelstringsimUm id de modelo de rerank, por exemplo cohere/rerank-v3.5.
querystringsimA consulta de busca.
documentsstring[]simTextos candidatos a pontuar.
top_nintegernãoRetorna apenas os N melhores resultados. Por padrão retorna todos.
return_documentsbooleannãoInclui o texto do documento em cada resultado.

Exemplo

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
  }'

Resposta

{
  "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 aponta para uma posição no seu array documents. Os resultados são ordenados por relevance_score, do maior para o menor.

Preços

Os modelos de rerank são cobrados por busca ao preço listado do modelo, exibido como "$ / 1K buscas". O custo está em usage.cost e é debitado do seu saldo em USD.

Listando modelos de rerank

curl "https://api14.com/api/v1/models?category=rerank"

Erros

StatusCódigoQuando
400model_required / invalid_jsonmodel ausente ou corpo malformado.
402insufficient_balanceSeu saldo em USD é $0.
403model_not_allowedA lista de permissões da chave exclui o modelo.
404model_not_foundId de modelo desconhecido ou desativado.
429rate_limitedLimite de requisições por minuto excedido.

Veja Erros.