Saltar para o conteúdo principal
POST
/
v1
/
rerank
curl -X POST "https://api.lemondata.cc/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
  }
}
Reordene documentos usando modelos de similaridade semântica. Útil para melhorar resultados de busca e aplicações de RAG.

​
Corpo da Requisição

​
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.
​
documents
array
obrigatório
Lista de documentos (strings) para reordenar.
​
top_n
integer
Número de resultados principais a retornar. O padrão é retornar todos os documentos.
​
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.lemondata.cc/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
  }
}

Corpo

application/json
​
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.

​
documents
object[]
obrigatório

Lista de documentos (strings) para reordenar.

​
top_n
integer

Número de resultados principais a retornar. O padrão é retornar todos os documentos.

​
return_documents
boolean

Se deve incluir o texto original do documento na resposta.

Resposta

200 - application/json

Response 200

​
results
object[]

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.