openai / Exports / OpenAIProvider
Class: OpenAIProvider
OpenAI provider implementation for Robota
Provides integration with OpenAI's GPT models following BaseAIProvider guidelines. Uses OpenAI SDK native types internally for optimal performance and feature support.
Hierarchy
AbstractAIProvider↳
OpenAIProvider
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new OpenAIProvider(options): OpenAIProvider
Parameters
| Name | Type |
|---|---|
options | IOpenAIProviderOptions |
Returns
Overrides
AbstractAIProvider.constructor
Defined in
Properties
name
• Readonly name: "openai"
Overrides
AbstractAIProvider.name
Defined in
version
• Readonly version: "1.0.0"
Overrides
AbstractAIProvider.version
Defined in
Methods
configure
▸ configure(config): Promise<void>
Configure the provider with type-safe configuration
Parameters
| Name | Type |
|---|---|
config | ProviderConfig |
Returns
Promise<void>
Inherited from
AbstractAIProvider.configure
Defined in
agents/dist/node/index.d.ts:3098
generateResponse
▸ generateResponse(payload): Promise<IRawProviderResponse>
Provider-agnostic raw response API.
This is the canonical "raw payload" entrypoint required by the AIProvider contract. The default implementation delegates to chat() and adapts the result into a RawProviderResponse shape.
Parameters
| Name | Type |
|---|---|
payload | IProviderRequest |
Returns
Promise<IRawProviderResponse>
Inherited from
AbstractAIProvider.generateResponse
Defined in
agents/dist/node/index.d.ts:3120
generateStreamingResponse
▸ generateStreamingResponse(payload): AsyncIterable<IRawProviderResponse, any, any>
Provider-agnostic raw streaming API.
If a provider does not implement chatStream, it does not support streaming.
Parameters
| Name | Type |
|---|---|
payload | IProviderRequest |
Returns
AsyncIterable<IRawProviderResponse, any, any>
Inherited from
AbstractAIProvider.generateStreamingResponse
Defined in
agents/dist/node/index.d.ts:3126
chat
▸ chat(messages, options?): Promise<TUniversalMessage>
Generate response using TUniversalMessage
Parameters
| Name | Type |
|---|---|
messages | TUniversalMessage[] |
options? | IChatOptions |
Returns
Promise<TUniversalMessage>
Overrides
AbstractAIProvider.chat
Defined in
chatStream
▸ chatStream(messages, options?): AsyncIterable<TUniversalMessage, any, any>
Generate streaming response using TUniversalMessage
Parameters
| Name | Type |
|---|---|
messages | TUniversalMessage[] |
options? | IChatOptions |
Returns
AsyncIterable<TUniversalMessage, any, any>
Overrides
AbstractAIProvider.chatStream
Defined in
supportsTools
▸ supportsTools(): boolean
Returns
boolean
Overrides
AbstractAIProvider.supportsTools
Defined in
validateConfig
▸ validateConfig(): boolean
Returns
boolean
Overrides
AbstractAIProvider.validateConfig
Defined in
dispose
▸ dispose(): Promise<void>
Returns
Promise<void>
Overrides
AbstractAIProvider.dispose