TypeScript SDKAPI ReferenceOperations

CreateRerankResponseBody - TypeScript SDK

CreateRerankResponseBody type definition

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

Rerank response containing ranked results

Example Usage

1import { CreateRerankResponseBody } from "@openrouter/sdk/models/operations";
2
3let value: CreateRerankResponseBody = {
4  model: "cohere/rerank-v3.5",
5  results: [
6    {
7      document: {},
8      index: 0,
9      relevanceScore: 0.98,
10    },
11  ],
12};

Fields

FieldTypeRequiredDescriptionExample
idstring➖Unique identifier for the rerank response (ORID format)gen-rerank-1234567890-abc
modelstring✔️The model used for rerankingcohere/rerank-v3.5
providerstring➖The provider that served the rerank requestCohere
resultsoperations.Result[]✔️List of rerank results sorted by relevance[
{"document": {"text": "Paris is the capital of France."},
“index”: 0,
“relevance_score”: 0.98
}
]
usageoperations.CreateRerankUsage➖Usage statistics{"search_units": 1,"total_tokens": 150}