Interface: AIAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>

Defined in: types.ts:676

AI adapter interface with support for endpoint-specific models and provider options.

Generic parameters:

• TChatModels: Models that support chat/text completion
• TEmbeddingModels: Models that support embeddings
• TChatProviderOptions: Provider-specific options for chat endpoint
• TEmbeddingProviderOptions: Provider-specific options for embedding endpoint
• TModelProviderOptionsByName: Map from model name to its specific provider options
• TModelInputModalitiesByName: Map from model name to its supported input modalities
• TMessageMetadataByModality: Map from modality type to adapter-specific metadata types

Type Parameters

TChatModels

TChatModels extends ReadonlyArray<string> = ReadonlyArray<string>

TEmbeddingModels

TEmbeddingModels extends ReadonlyArray<string> = ReadonlyArray<string>

TChatProviderOptions

TChatProviderOptions extends Record<string, any> = Record<string, any>

TEmbeddingProviderOptions

TEmbeddingProviderOptions extends Record<string, any> = Record<string, any>

TModelProviderOptionsByName

TModelProviderOptionsByName extends Record<string, any> = Record<string, any>

TModelInputModalitiesByName

TModelInputModalitiesByName extends Record<string, ReadonlyArray<Modality>> = Record<string, ReadonlyArray<Modality>>

TMessageMetadataByModality

TMessageMetadataByModality extends object = DefaultMessageMetadataByModality

Properties

_chatProviderOptions?

optional _chatProviderOptions: TChatProviderOptions;

optional _chatProviderOptions: TChatProviderOptions;

Defined in: types.ts:702

_embeddingProviderOptions?

optional _embeddingProviderOptions: TEmbeddingProviderOptions;

optional _embeddingProviderOptions: TEmbeddingProviderOptions;

Defined in: types.ts:703

_messageMetadataByModality?

optional _messageMetadataByModality: TMessageMetadataByModality;

optional _messageMetadataByModality: TMessageMetadataByModality;

Defined in: types.ts:720

Type-only map from modality type to adapter-specific metadata types. Used to provide type-safe autocomplete for metadata on content parts.

_modelInputModalitiesByName?

optional _modelInputModalitiesByName: TModelInputModalitiesByName;

optional _modelInputModalitiesByName: TModelInputModalitiesByName;

Defined in: types.ts:715

Type-only map from model name to its supported input modalities. Used by the core AI types to narrow ContentPart types based on the selected model. Must be provided by all adapters.

_modelProviderOptionsByName

_modelProviderOptionsByName: TModelProviderOptionsByName;

_modelProviderOptionsByName: TModelProviderOptionsByName;

Defined in: types.ts:709

Type-only map from model name to its specific provider options. Used by the core AI types to narrow providerOptions based on the selected model. Must be provided by all adapters.

_providerOptions?

optional _providerOptions: TChatProviderOptions;

optional _providerOptions: TChatProviderOptions;

Defined in: types.ts:701

chatStream()

chatStream: (options) => AsyncIterable<StreamChunk>;

chatStream: (options) => AsyncIterable<StreamChunk>;

Defined in: types.ts:723

Parameters

options

ChatOptions<string, TChatProviderOptions>

Returns

AsyncIterable<StreamChunk>

createEmbeddings()

createEmbeddings: (options) => Promise<EmbeddingResult>;

createEmbeddings: (options) => Promise<EmbeddingResult>;

Defined in: types.ts:731

Parameters

options

EmbeddingOptions

Returns

Promise<EmbeddingResult>

embeddingModels?

optional embeddingModels: TEmbeddingModels;

optional embeddingModels: TEmbeddingModels;

Defined in: types.ts:698

Models that support embeddings

models

models: TChatModels;

models: TChatModels;

Defined in: types.ts:695

Models that support chat/text completion

name

name: string;

name: string;

Defined in: types.ts:693

summarize()

summarize: (options) => Promise<SummarizationResult>;

summarize: (options) => Promise<SummarizationResult>;

Defined in: types.ts:728

Parameters

options

SummarizationOptions

Returns

Promise<SummarizationResult>