Vai al contenuto principale
POST
Rerank documents (Cohere v2-compatible)

Autorizzazioni

Authorization
string
header
obbligatorio

A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).

Corpo

application/json
query
string
obbligatorio
Minimum string length: 1
documents
(string | object)[]
obbligatorio

Up to 100 strings or { text } objects (1,000 on a custom reranker).

Required array length: 1 - 1000 elements
model
string

Omit for the default reranker.

top_n
integer

Return only the best top_n. Default all.

Intervallo richiesto: x >= 0
return_documents
boolean
predefinito:false

Add each result's document text, as sent.

max_tokens_per_doc
integer

Truncate each document to about this many tokens (4 characters each). 0 is no limit.

Intervallo richiesto: x >= 0

Risposta

Scores, best first. index points into the request's documents.

id
string
obbligatorio

The request id.

model
string
obbligatorio
results
object[]
obbligatorio
unscored
integer[]
obbligatorio

Indexes of documents that were not scored. Usually empty.

usage
object
obbligatorio