API Referencev1/rerank

Rerank V1 API

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Client-NamestringOptional
The name of the project that is making the request.

Request

This endpoint expects an object.
querystringRequired
The search query
documentslist of strings or maps from strings to stringsRequired

A list of document objects or strings to rerank. If a document is provided the text fields is required and all other fields will be preserved in the response.

The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000.

We recommend a maximum of 1,000 documents for optimal endpoint performance.

modelstringOptional

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

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

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_documentsbooleanOptional
  • 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_docintegerOptional
The maximum number of chunks to produce internally from a document

Response

OK
resultslist of objects
An ordered list of ranked documents
idstring or null
metaobject or null

Errors