Texto
Reordenar Documentos
Reordena documentos por relevância para uma consulta
Reordene documentos usando modelos de similaridade semântica. Útil para melhorar resultados de busca e aplicações de RAG.
Corpo da Requisição
Para entradas grandes, configure o timeout do cliente HTTP para pelo menos 120s. A resposta chega após o processamento.
ID do modelo de reranker a ser usado (ex: qwen3-vl-rerank).
A consulta para classificar os documentos. Comprimento máximo: 32,000 caracteres.
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.
Número dos melhores resultados, de 1 até documents.length. Se omitido, o modelo selecionado determina a quantidade.
falseSe deve incluir o texto original do documento na resposta.
Resposta
Lista classificada de documentos com pontuações.
Cada resultado contém:
index(integer): Índice original do documentorelevance_score(number): Pontuação de relevância. O intervalo depende do modelo selecionado.document(string): Texto original (sereturn_documents=true)
O modelo usado para a reordenação. Retornado quando disponível.
Estatísticas de uso de tokens. Retornado quando disponível.
Requisição
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
}'Resposta
{
"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
}
}Autorização
BearerAuth Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.
Local: header
Cabeçalhos
Política de entrega por solicitação. Substitui os padrões da API key e do Workspace. Tenta automaticamente o TokenLab Verified primeiro e pode alternar uma vez para Official apenas antes da saída, aceitação da solicitação ou criação de recurso persistente.
Valores permitidos
- "auto"
- "verified"
- "official"
Corpo da requisição
application/json
Resposta
application/json
application/json
application/json
application/json