RerankOptions

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

Options passed to a RerankAdapter. Documents reach the adapter already serialized to strings — the rerank() activity stringifies object documents and maps results back to the original elements, so adapters never deal with the caller's document type.

Type Parameters#

TProviderOptions#

TProviderOptions extends object = Record<string, unknown>

Properties#

abortSignal?#

optional abortSignal?: AbortSignal;

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

Forwarded to the provider request for cancellation.

documents#

documents: string[];

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

Documents to rerank, pre-serialized to strings by the activity.

logger#

logger: InternalLogger;

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

Internal logger threaded from the rerank() entry point. Adapters must call logger.request() before the provider call and logger.errors() in catch blocks.

model#

model: string;

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

modelOptions?#

optional modelOptions?: TProviderOptions;

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

Provider-specific options forwarded by the rerank() activity.

query#

query: string;

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

The search query documents are scored against.

topN?#

optional topN?: number;

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

Return only the top N results. Passed through to the provider.