Texto
Rerank Documents
Reclassifica documentos por relevância em relação a uma consulta
Use GET /v1/models?recommended_for=rerank para listar os modelos de rerank atuais. Use um modelo cujos detalhes listem a operação rerank.
Reclassifique documentos usando modelos de similaridade semântica. Útil para melhorar resultados de busca e aplicações de RAG.
Corpo da Requisição
Este endpoint retorna após a conclusão da classificação. Para grandes conjuntos de documentos, defina o timeout do seu cliente HTTP para pelo menos 120s.
ID do modelo de reranker a ser utilizado (ex: qwen3-vl-rerank).
A consulta para classificar os documentos. Comprimento máximo: 32.000 caracteres.
Lista de documentos (strings) para reclassificar. Limites: até 1.000 documentos, cada documento com até 100.000 caracteres e, no máximo, 2.000.000 de caracteres totais nos documentos.
Número de resultados principais a serem retornados, de 1 até documents.length. Se omitido, o modelo selecionado determina o número de resultados.
falseSe deve incluir o texto original do documento em cada resultado. Envie apenas quando os detalhes do modelo listarem return_documents.
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 utilizado para a reclassificação. Quando disponível.
Uso reportado para a requisição, quando disponível: total_tokens ou search_units para modelos cobrados por busca.
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": {
"total_tokens": 45
}
}Erros
| Status | Código | Causa |
|---|---|---|
400 | invalid_request | Um campo está faltando, vazio ou acima do limite definido. param nomeia o campo |
400 | unsupported_endpoint | O modelo não está publicado para este endpoint |
Trate outros status conforme Lidar com erros de API.
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
application/json
application/json
application/json