agents / Exports / TypeSafeAIProvider
Interface: TypeSafeAIProvider<TConfig>
Type-safe AI provider interface with proper generic constraints
Template
Message type (defaults to TUniversalMessage for backward compatibility)
Template
Response type (defaults to TUniversalMessage for backward compatibility)
Type parameters
| Name | Type | Description |
|---|---|---|
TConfig | ProviderConfig | Provider configuration type (defaults to ProviderConfig for type safety) |
Implemented by
Table of contents
Properties
Methods
Properties
name
• Readonly name: string
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:30
version
• Readonly version: string
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:31
Methods
configure
▸ configure(config): void | Promise<void>
Parameters
| Name | Type |
|---|---|
config | TConfig |
Returns
void | Promise<void>
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:33
chat
▸ chat(messages, options?): Promise<TUniversalMessage>
Parameters
| Name | Type |
|---|---|
messages | TUniversalMessage[] |
options? | IChatOptions |
Returns
Promise<TUniversalMessage>
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:34
chatStream
▸ chatStream(messages, options?): AsyncIterable<TUniversalMessage, any, any>
Parameters
| Name | Type |
|---|---|
messages | TUniversalMessage[] |
options? | IChatOptions |
Returns
AsyncIterable<TUniversalMessage, any, any>
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:35
generateResponse
▸ generateResponse(payload): Promise<IRawProviderResponse>
Parameters
| Name | Type |
|---|---|
payload | IProviderRequest |
Returns
Promise<IRawProviderResponse>
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:36
generateStreamingResponse
▸ generateStreamingResponse(payload): AsyncIterable<IRawProviderResponse, any, any>
Parameters
| Name | Type |
|---|---|
payload | IProviderRequest |
Returns
AsyncIterable<IRawProviderResponse, any, any>
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:37
supportsTools
▸ supportsTools(): boolean
Returns
boolean
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:38
validateConfig
▸ validateConfig(): boolean
Returns
boolean
Defined in
packages/agents/src/abstracts/abstract-ai-provider.ts:39
dispose
▸ dispose(): Promise<void>
Returns
Promise<void>