Rerank API (v1)

This endpoint takes in a query and a list of texts and produces an ordered array with each text assigned a relevance score.

post/v1/rerank

Request

  • Base URL: https://api.cohere.com
  • URL: https://api.cohere.com/v1/rerank
  • Auth: HTTP bearer

Headers

X-Client-Namestring

The name of the project that is making the request.

Request body

modelstring

The identifier of the model to use, eg rerank-v3.5.

querystring required

The search query

top_ninteger

The number of most relevant documents or indices to return, defaults to the length of the documents

rank_fieldsstring[]

If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.

return_documentsboolean
  • If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request.
  • If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.
max_chunks_per_docinteger

The maximum number of chunks to produce internally from a document

Response

OK

idstring

Changes

No recorded changes to this operation across all 1 revision of this API.