Abstract Class: BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>

Defined in: base-adapter.ts:26

Base adapter class 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: Provider-specific options for model by name
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

Implements

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

Constructors

Constructor

new BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>(config): BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>;

new BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>(config): BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>;

Defined in: base-adapter.ts:69

Parameters

config

AIAdapterConfig = {}

Returns

BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>

Properties

_chatProviderOptions?

optional _chatProviderOptions: TChatProviderOptions;

optional _chatProviderOptions: TChatProviderOptions;

Defined in: base-adapter.ts:60

Implementation of

AIAdapter._chatProviderOptions

_embeddingProviderOptions?

optional _embeddingProviderOptions: TEmbeddingProviderOptions;

optional _embeddingProviderOptions: TEmbeddingProviderOptions;

Defined in: base-adapter.ts:61

Implementation of

AIAdapter._embeddingProviderOptions

_messageMetadataByModality?

optional _messageMetadataByModality: TMessageMetadataByModality;

optional _messageMetadataByModality: TMessageMetadataByModality;

Defined in: base-adapter.ts:67

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

Implementation of

AIAdapter._messageMetadataByModality

_modelInputModalitiesByName?

optional _modelInputModalitiesByName: TModelInputModalitiesByName;

optional _modelInputModalitiesByName: TModelInputModalitiesByName;

Defined in: base-adapter.ts:65

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.

Implementation of

AIAdapter._modelInputModalitiesByName

_modelProviderOptionsByName

_modelProviderOptionsByName: TModelProviderOptionsByName;

_modelProviderOptionsByName: TModelProviderOptionsByName;

Defined in: base-adapter.ts:63

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.

Implementation of

AIAdapter._modelProviderOptionsByName

_providerOptions?

optional _providerOptions: TChatProviderOptions;

optional _providerOptions: TChatProviderOptions;

Defined in: base-adapter.ts:59

Implementation of

AIAdapter._providerOptions

config

protected config: AIAdapterConfig;

protected config: AIAdapterConfig;

Defined in: base-adapter.ts:56

embeddingModels?

optional embeddingModels: TEmbeddingModels;

optional embeddingModels: TEmbeddingModels;

Defined in: base-adapter.ts:55

Models that support embeddings

Implementation of

AIAdapter.embeddingModels

models

abstract models: TChatModels;

abstract models: TChatModels;

Defined in: base-adapter.ts:54

Models that support chat/text completion

Implementation of

AIAdapter.models

name

abstract name: string;

abstract name: string;

Defined in: base-adapter.ts:53

abstract chatStream(options): AsyncIterable<StreamChunk>;

abstract chatStream(options): AsyncIterable<StreamChunk>;

Defined in: base-adapter.ts:73

abstract createEmbeddings(options): Promise<EmbeddingResult>;

abstract createEmbeddings(options): Promise<EmbeddingResult>;

Defined in: base-adapter.ts:78

protected generateId(): string;

protected generateId(): string;

Defined in: base-adapter.ts:80

Returns

string

summarize()

abstract summarize(options): Promise<SummarizationResult>;

abstract summarize(options): Promise<SummarizationResult>;

Defined in: base-adapter.ts:75