Skip to main content
POST
Document reranking endpoint

Body

application/json

Request for document reranking

documents
string[]
required

Documents to rerank

model
string
required

Model ID to use for reranking

query
string
required

Query to rerank documents against

return_documents
boolean | null

Whether to include document text in each result. Defaults to true.

top_n
integer | null

Maximum number of ranked results to return

Required range: x >= 0

Response

Successful rerank

Response from document reranking

id
string
required

Unique identifier for the rerank request

model
string
required

Model used for reranking

results
object[]
required

Reranked results

usage
null | object

Usage information (optional)