Skip to main content
POST
Rerank

Introduction

Rerank a list of candidate documents by relevance to a query. Commonly used in RAG and knowledge-base search.

Authentication

string
required
Bearer Token, e.g. Bearer sk-xxxxxxxxxx

Request parameters

string
required
Rerank model, e.g. rerank-english-v2.0
string
required
Query text
array
required
Documents to rerank (strings or objects)
integer
Return top N results
boolean
default:"false"
Include document text in results

Request example

Common parameters

  • query: User question or search query
  • documents: Candidate passages
  • top_n: Limit to top N hits
  • return_documents: Include source text when true
The results array contains index and relevance_score, sorted by score.