Skip to content

agents / Exports / TypeSafeAIProvider

Interface: TypeSafeAIProvider<TConfig, TMessage, TResponse>

Type-safe AI provider interface with proper generic constraints

Type parameters

NameTypeDescription
TConfigProviderConfigProvider configuration type (defaults to ProviderConfig for type safety)
TMessageUniversalMessageMessage type (defaults to UniversalMessage for backward compatibility)
TResponseUniversalMessageResponse type (defaults to UniversalMessage for backward compatibility)

Implemented by

Table of contents

Properties

Methods

Properties

name

Readonly name: string

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:19


version

Readonly version: string

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:20

Methods

configure

configure(config): void | Promise<void>

Parameters

NameType
configTConfig

Returns

void | Promise<void>

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:22


chat

chat(messages, options?): Promise<TResponse>

Parameters

NameType
messagesTMessage[]
options?ChatOptions

Returns

Promise<TResponse>

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:23


chatStream

chatStream(messages, options?): AsyncIterable<TResponse, any, any>

Parameters

NameType
messagesTMessage[]
options?ChatOptions

Returns

AsyncIterable<TResponse, any, any>

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:24


supportsTools

supportsTools(): boolean

Returns

boolean

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:25


validateConfig

validateConfig(): boolean

Returns

boolean

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:26


dispose

dispose(): Promise<void>

Returns

Promise<void>

Defined in

packages/agents/src/abstracts/base-ai-provider.ts:27

Released under the MIT License.