RerankResult

Defined in: packages/ai/src/types.ts:2303

Public result of the rerank() activity, generic over the caller's document element type so document / rerankedDocuments carry the original values (strings or objects), not their serialized form.

Type Parameters#

TDocument#

TDocument = string

Properties#

id#

id: string;

Defined in: packages/ai/src/types.ts:2304

model#

model: string;

Defined in: packages/ai/src/types.ts:2305

ranking#

ranking: object[];

Defined in: packages/ai/src/types.ts:2307

Scored results, highest relevance first.

document#

document: TDocument;

index#

index: number;

score#

score: number;

rerankedDocuments#

rerankedDocuments: TDocument[];

Defined in: packages/ai/src/types.ts:2309

The documents reordered by relevance — ranking.map(r => r.document).

usage#

usage: TokenUsage;

Defined in: packages/ai/src/types.ts:2316

Usage for the request. Rerank typically bills in provider-defined "search units" (usage.billed = { quantity, unit: 'units' }) rather than tokens. Some providers (e.g. OpenRouter) may also report totalTokens and cost. Cohere reports only search units and leaves the token counts at 0.