Skip to main content
POST
Rerank documents

Authorizations

Authorization
string
header
required

Use Authorization: Bearer sk-... from https://omniall.ai/dashboard

Body

application/json

Rerank documents by relevance to a query.

model
string
required

Rerank model id.

Example:

"rerank-english-v2.0"

query
string
required

The search/query text used to score documents.

documents
(string | object)[]
required

Documents to rank. Each item can be a plain string or an object, depending on the model.

top_n
integer

Return only the top N results (optional).

return_documents
boolean
default:false

If true, include document text/objects in the response results.

Response

Rerank results

Rerank results, sorted by relevance.

id
string

Request/result id.

results
object[]

Ranked hits.

meta
object

Optional provider metadata.