Skip to main content
POST
/
rerank
Python
Example file not found: rerank_python.txt
{
  "id": "<string>",
  "results": [
    {
      "index": 123,
      "relevance_score": 0.5,
      "document": {
        "text": "<string>",
        "metadata": {}
      }
    }
  ],
  "model": "<string>",
  "usage": {},
  "cost": {
    "generation": 123,
    "platform": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for reranking.

​
query
string
required

The search query to rank documents against

​
documents
RerankDocument · object[]
required

List of documents to rerank

Required array length: 1 - 1000 elements
​
model
string
required

The reranking model to use

​
top_k
integer | null

Number of top documents to return. Defaults to all documents.

Required range: x >= 1
​
return_documents
boolean
default:true

Whether to return document content in the response

​
max_chunks_per_doc
integer | null

Maximum number of chunks per document

Required range: x >= 1

Response

Successful Response

Response model for reranking.

​
id
string
required

Unique identifier for this rerank request

​
results
RerankResult · object[]
required

Ranked results

​
model
string
required

The model used for reranking

​
usage
Usage · object
required

Usage information

​
cost
RerankCost · object

Cost information for this rerank request