Texto

Reordenar documentos

Reordena documentos por relevancia respecto a una consulta

POST
/v1/rerank

Reordena documentos utilizando modelos de similitud semántica. Útil para mejorar los resultados de búsqueda y las aplicaciones RAG.

Cuerpo de la solicitud

Para entradas grandes, configura el tiempo de espera del cliente HTTP en al menos 120s. La respuesta llega al terminar el procesamiento.

modelstringobligatorio

ID del modelo de reranker a utilizar (por ejemplo, qwen3-vl-rerank).

querystringobligatorio

La consulta con la que se clasificarán los documentos. Longitud máxima: 32,000 caracteres.

documentsarrayobligatorio

Lista de documentos (cadenas de texto) a reordenar. Límites: hasta 1,000 documentos, cada documento hasta 100,000 caracteres y como máximo 2,000,000 caracteres de documentos en total.

top_ninteger

Número de mejores resultados, de 1 a documents.length. Si se omite, el modelo seleccionado determina la cantidad.

return_documentsbooleanpredeterminado: false

Indica si se debe incluir el texto original del documento en la respuesta.

Respuesta

resultsarray

Lista clasificada de documentos con puntuaciones.

Cada resultado contiene:

  • index (integer): Índice original del documento
  • relevance_score (number): Puntuación de relevancia. El rango depende del modelo seleccionado.
  • document (string): Texto original (si return_documents=true)
modelstring

El modelo utilizado para el reordenamiento. Se devuelve cuando está disponible.

usageobject

Estadísticas de uso de tokens. Se devuelve cuando está disponible.

Solicitud

curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen3-vl-rerank",
    "query": "What is machine learning?",
    "documents": [
      "Machine learning is a subset of AI",
      "The weather is nice today",
      "Deep learning uses neural networks"
    ],
    "top_n": 2,
    "return_documents": true
  }'

Respuesta

Response
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "Machine learning is a subset of AI"
    },
    {
      "index": 2,
      "relevance_score": 0.82,
      "document": "Deep learning uses neural networks"
    }
  ],
  "model": "qwen3-vl-rerank",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}

Autorización

BearerAuth
AuthorizationBearer <token>

Autenticación con API Key. Cree o gestione API keys en Dashboard > API > API Keys.

Ubicación: header

Encabezados

X-TokenLab-Delivery-Policy?string

Política de entrega por solicitud. Sustituye los valores predeterminados de la API key y del Workspace. Auto intenta primero con TokenLab Verified y puede cambiar una vez a Official solo antes de la salida, la aceptación de la solicitud o la creación de recursos persistentes.

Valores permitidos

  • "auto"
  • "verified"
  • "official"

Cuerpo de la solicitud

application/json

Respuesta

application/json

application/json

application/json

application/json