openai / Exports / OpenAIProvider
Class: OpenAIProvider
OpenAI provider implementation
Implements the AIProvider interface to integrate with Robota.
Implements
unknown
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new OpenAIProvider(options): OpenAIProvider
Parameters
| Name | Type |
|---|---|
options | OpenAIProviderOptions |
Returns
Defined in
Properties
name
• name: string = 'openai'
Provider name
Defined in
type
• type: string = 'openai'
Client type
Defined in
instance
• instance: OpenAI
Client instance
Defined in
options
• options: OpenAIProviderOptions
Provider options
Defined in
Methods
formatMessages
▸ formatMessages(messages): ChatCompletionMessageParam[]
Convert messages to OpenAI format
Parameters
| Name | Type |
|---|---|
messages | Message[] |
Returns
ChatCompletionMessageParam[]
Deprecated
Use OpenAIConversationAdapter.toOpenAIFormat instead
Defined in
formatFunctions
▸ formatFunctions(functions): ChatCompletionTool[]
Convert function definitions to OpenAI format
Parameters
| Name | Type |
|---|---|
functions | FunctionDefinition[] |
Returns
ChatCompletionTool[]
Defined in
parseResponse
▸ parseResponse(response): ModelResponse
Convert OpenAI API response to standard format
Parameters
| Name | Type |
|---|---|
response | ChatCompletion |
Returns
ModelResponse
Defined in
parseStreamingChunk
▸ parseStreamingChunk(chunk): StreamingResponseChunk
Convert streaming response chunk to standard format
Parameters
| Name | Type |
|---|---|
chunk | ChatCompletionChunk |
Returns
StreamingResponseChunk
Defined in
chat
▸ chat(model, context, options?): Promise<ModelResponse>
Model chat request
Parameters
| Name | Type |
|---|---|
model | string |
context | Context |
options? | any |
Returns
Promise<ModelResponse>
Defined in
chatStream
▸ chatStream(model, context, options?): AsyncGenerator<StreamingResponseChunk, void, unknown>
Model chat streaming request
Parameters
| Name | Type |
|---|---|
model | string |
context | Context |
options? | any |
Returns
AsyncGenerator<StreamingResponseChunk, void, unknown>
Defined in
close
▸ close(): Promise<void>
Release resources (if needed)
Returns
Promise<void>