Referencia de la API

Rerank

Reordena los documentos candidatos según la relevancia con la consulta.

La API de Rerank toma una consulta y documentos candidatos, y luego devuelve resultados ordenados por relevancia. Se usa comúnmente después de la recuperación en flujos de RAG.

Punto de conexión

MétodoRutaDescripción
POST/v1/rerankReordenar documentos candidatos

Campos de Solicitud

CampoTipoRequeridoDescripción
modelstringID del modelo de rerank
querystringTexto de la consulta
documentsarrayDocumentos candidatos, como cadenas u objetos
top_nintegerNoDevuelve los N mejores resultados
return_documentsbooleanNoIncluye el documento original en cada resultado, por defecto false
max_chunk_per_docintegerNoNúmero máximo de fragmentos por documento, según el soporte del canal
overlap_tokensintegerNoCantidad de tokens de solapamiento entre fragmentos, según el soporte del canal

curl

curl https://api.tensoraxis.com/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TENSORAXIS_API_KEY" \
  -d '{
    "model": "jina-reranker-v2-base-multilingual",
    "query": "What is an API gateway?",
    "documents": [
      "An API gateway handles authentication, routing and rate limiting.",
      "A vector database is used for similarity search.",
      "Object storage stores files."
    ],
    "top_n": 2,
    "return_documents": true
  }'

Estructura de la Respuesta

{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.98,
      "document": "An API gateway handles authentication, routing and rate limiting."
    }
  ],
  "usage": {
    "total_tokens": 42
  }
}

Cuando return_documents es false, los resultados normalmente incluyen solo index y relevance_score.