Skip to main content
POST
Rank texts relative to a query

Body

application/json

Request to rank texts against a query.

query
required

Query string(s) used to rank provided documents. Required.

documents
required

Documents to rerank; can be a flat list or grouped lists corresponding to multiple queries. Required.

top_n
integer

Maximum number of reranked results to return.

max_tokens_per_doc
integer

Maximum number of tokens to consider per document during reranking.

Response

200 - application/json

Ranking results (pipeline output)

results
object[]