Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt

Use this file to discover all available pages before exploring further.

Reordene documentos usando modelos de similaridade semântica. Útil para melhorar resultados de busca e aplicações de RAG.

​
Corpo da Requisição

Timeout de solicitações síncronas: este endpoint não-chat aguarda o modelo roteado terminar. Entradas grandes, áudios longos ou lotes grandes podem exceder os padrões comuns de 30s dos clientes, então configure o timeout do seu cliente HTTP para pelo menos 120s.
​
model
string
obrigatório
ID do modelo de reranker a ser usado (ex: BAAI/bge-reranker-v2-m3, qwen3-rerank).
​
query
string
obrigatório
A consulta para classificar os documentos. Comprimento máximo: 32,000 caracteres.
​
documents
array
obrigatório
Lista de documentos (strings) para reordenar. Limites: até 1,000 documentos, cada documento com até 100,000 caracteres e no máximo 2,000,000 caracteres de documentos no total.
​
top_n
integer
Número de resultados principais a retornar. O padrão é retornar todos os documentos. Deve ser pelo menos 1 e não pode ser maior que documents.length. Atualmente a TokenLab não tem um limite rígido inferior específico de provedor sob governança; se um provedor publicar um posteriormente, ele deverá ser adicionado primeiro à truth de request-shape de rerank antes de ser documentado ou aplicado.
​
return_documents
boolean
padrão:"false"
Se deve incluir o texto original do documento na resposta.

​
Resposta

​
results
array
Lista classificada de documentos com pontuações.Cada resultado contém:
  • index (integer): Índice original do documento
  • relevance_score (number): Pontuação de relevância (0-1)
  • document (string): Texto original (se return_documents=true)
​
model
string
O modelo usado para a reordenação.
​
usage
object
Estatísticas de uso de tokens.
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-reranker-v2-m3",
    "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
  }'

{
  "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": "BAAI/bge-reranker-v2-m3",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}