CreateRerankRequestBody Type | OpenRouter TypeScript SDK | OpenRouter

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Rerank request input

Example Usage

1 import { CreateRerankRequestBody } from "@openrouter/sdk/models/operations";
2 
3 let value: CreateRerankRequestBody = {
4   model: "cohere/rerank-v3.5",
5   query: "What is the capital of France?",
6   documents: [
7     "Paris is the capital of France.",
8     "Berlin is the capital of Germany.",
9   ],
10 };

Fields

Field	Type	Required	Description	Example
`model`	string	✔️	The rerank model to use	cohere/rerank-v3.5
`query`	string	✔️	The search query to rerank documents against	What is the capital of France?
`documents`	string[]	✔️	The list of documents to rerank	[ “Paris is the capital of France.”, “Berlin is the capital of Germany.” ]
`topN`	number	➖	Number of most relevant documents to return	3
`provider`	models.ProviderPreferences	➖	Provider routing preferences for the request.