agent-core / Exports / IAIProvider
Interface: IAIProvider
Provider-agnostic AI Provider interface This interface uses only TUniversalMessage types and avoids provider-specific types
Implemented by
Table of contents
Properties
Methods
Properties
name
• Readonly name: string
Provider identifier
Defined in
packages/agent-core/src/interfaces/provider.ts:175
version
• Readonly version: string
Provider version
Defined in
packages/agent-core/src/interfaces/provider.ts:177
Methods
chat
▸ chat(messages, options?): Promise<TUniversalMessage>
Generate response from AI model using TUniversalMessage
Parameters
| Name | Type | Description |
|---|---|---|
messages | TUniversalMessage[] | Array of TUniversalMessage from conversation history |
options? | IChatOptions | Chat options including tools, model settings, etc. |
Returns
Promise<TUniversalMessage>
Promise resolving to a TUniversalMessage response
Defined in
packages/agent-core/src/interfaces/provider.ts:185
chatStream
▸ chatStream(messages, options?): AsyncIterable<TUniversalMessage, any, any>
Generate streaming response from AI model using TUniversalMessage
Parameters
| Name | Type | Description |
|---|---|---|
messages | TUniversalMessage[] | Array of TUniversalMessage from conversation history |
options? | IChatOptions | Chat options including tools, model settings, etc. |
Returns
AsyncIterable<TUniversalMessage, any, any>
AsyncIterable of TUniversalMessage chunks
Defined in
packages/agent-core/src/interfaces/provider.ts:193
generateResponse
▸ generateResponse(payload): Promise<IRawProviderResponse>
Generate response from AI model (raw provider response)
Parameters
| Name | Type | Description |
|---|---|---|
payload | IProviderRequest | Provider request payload |
Returns
Promise<IRawProviderResponse>
Promise resolving to raw provider response
Defined in
packages/agent-core/src/interfaces/provider.ts:203
generateStreamingResponse
▸ generateStreamingResponse(payload): AsyncIterable<IRawProviderResponse, any, any>
Generate streaming response from AI model (raw provider response)
Parameters
| Name | Type | Description |
|---|---|---|
payload | IProviderRequest | Provider request payload |
Returns
AsyncIterable<IRawProviderResponse, any, any>
AsyncIterable of raw provider response chunks
Defined in
packages/agent-core/src/interfaces/provider.ts:210
supportsTools
▸ supportsTools(): boolean
Check if the provider supports tool calling
Returns
boolean
true if tool calling is supported
Defined in
packages/agent-core/src/interfaces/provider.ts:216
validateConfig
▸ validateConfig(): boolean
Validate provider configuration
Returns
boolean
true if configuration is valid
Defined in
packages/agent-core/src/interfaces/provider.ts:222
dispose
▸ dispose(): Promise<void>
Clean up resources when provider is no longer needed
Returns
Promise<void>
Defined in
packages/agent-core/src/interfaces/provider.ts:227
close
▸ close(): Promise<void>
Close provider connections and cleanup resources
Returns
Promise<void>