Example Usage
import { CreateRerankRequestBody } from "@openrouter/sdk/models/operations";
let value: CreateRerankRequestBody = {
documents: [
"Paris is the capital of France.",
"Berlin is the capital of Germany.",
],
model: "cohere/rerank-v3.5",
query: "What is the capital of France?",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
documents | operations.Document[] | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with text and/or image for multimodal models. | [ “Paris is the capital of France.”, “Berlin is the capital of Germany.” ] |
model | string | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 |
provider | models.ProviderPreferences | :heavy_minus_sign: | N/A | { “allow_fallbacks”: true } |
query | string | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? |
topN | number | :heavy_minus_sign: | Number of most relevant documents to return | 3 |