BaseRerankAdapter

Defined in: packages/ai/src/activities/rerank/adapter.ts:63

Abstract base class for rerank adapters. Extend this class to implement a rerank adapter for a specific provider.

Generic parameters match RerankAdapter - all pre-resolved by the provider function.

Type Parameters#

TModel#

TModel extends string = string

TProviderOptions#

TProviderOptions extends object = Record<string, unknown>

Implements#

• RerankAdapter<TModel, TProviderOptions>

Constructors#

Constructor#

new BaseRerankAdapter<TModel, TProviderOptions>(config?, model): BaseRerankAdapter<TModel, TProviderOptions>;

Defined in: packages/ai/src/activities/rerank/adapter.ts:78

Parameters#

config?#

RerankAdapterConfig = {}

model#

TModel

Returns#

BaseRerankAdapter<TModel, TProviderOptions>

Properties#

~types#

~types: object;

Defined in: packages/ai/src/activities/rerank/adapter.ts:72

Internal

Type-only properties for inference. Not assigned at runtime.

providerOptions#

providerOptions: TProviderOptions;

Implementation of#

RerankAdapter.~types

config#

protected config: RerankAdapterConfig;

Defined in: packages/ai/src/activities/rerank/adapter.ts:76

kind#

readonly kind: "rerank";

Defined in: packages/ai/src/activities/rerank/adapter.ts:67

Discriminator for adapter kind

Implementation of#

RerankAdapter.kind

model#

readonly model: TModel;

Defined in: packages/ai/src/activities/rerank/adapter.ts:69

The model this adapter is configured for

Implementation of#

RerankAdapter.model

name#

abstract readonly name: string;

Defined in: packages/ai/src/activities/rerank/adapter.ts:68

Adapter name identifier

Implementation of#

RerankAdapter.name

Methods#

generateId()#

protected generateId(): string;

Defined in: packages/ai/src/activities/rerank/adapter.ts:87

Returns#

string

rerank()#

abstract rerank(options): Promise<RerankAdapterResult>;

Defined in: packages/ai/src/activities/rerank/adapter.ts:83

Rerank the given (pre-serialized) documents against the query, returning scored indices into options.documents. The activity layer maps these back to the caller's original documents.

Parameters#

options#

RerankOptions<TProviderOptions>

Returns#

Promise<RerankAdapterResult>

Implementation of#

RerankAdapter.rerank