Referencia API

Rerank

Mejora la calidad de búsqueda y recuperación reordenando la relevancia de documentos usando modelos de Cohere, Jina AI y otros proveedores a través de un único endpoint.

Endpoint

http
POST https://api.tokspan.com/v1/rerank

Parámetros de la Solicitud

ParámetroTipoRequeridoDescripción
modelstringID del modelo de rerank (ej., cohere-rerank-v3, jina-reranker-v2)
querystringLa consulta de búsqueda contra la cual evaluar los documentos
documentsarrayLista de cadenas de texto u objetos de documento a reordenar
top_nintegerNoDevolver solo los N resultados principales. Predeterminado: devuelve todos
return_documentsbooleanNoIncluir el texto del documento en la respuesta. Predeterminado: true

Ejemplo

Envíe una consulta con una lista de documentos candidatos y reciba resultados con puntuación de relevancia:

python
import requests

response = requests.post(
    "https://api.tokspan.com/v1/rerank",
    headers={
        "Authorization": "Bearer sk-your-key",
        "Content-Type": "application/json",
    },
    json={
        "model": "cohere-rerank-v3",
        "query": "What is the capital of France?",
        "documents": [
            "Paris is the capital of France.",
            "Berlin is the capital of Germany.",
            "France is a country in Europe.",
        ],
        "top_n": 2,
    },
)

for result in response.json()["results"]:
    print(f"Score: {result['relevance_score']:.3f}{result['document']['text']}")

Casos de Uso Comunes

  • Pipelines RAG — Reordene los fragmentos recuperados antes de pasarlos al LLM para respuestas más precisas
  • Búsqueda híbrida — Combine resultados de búsqueda por palabras clave (BM25) y vectorial, luego reordene para mejor relevancia
  • Recuperación multi-etapa — Pipeline de recuperación gruesa → rerank → generación

Modelos Disponibles

Los modelos de reranking compatibles incluyen Cohere Rerank v3, Jina Reranker v2 y BGE-Reranker. Consulte la página de Modelos para el catálogo completo y precios por modelo.