Skip to content

openai / Exports / OpenAIConversationAdapter

Class: OpenAIConversationAdapter

OpenAI Conversation Adapter

Converts between UniversalMessage format and OpenAI native types. Provides bidirectional conversion for seamless integration.

Table of contents

Constructors

Methods

Constructors

constructor

new OpenAIConversationAdapter(): OpenAIConversationAdapter

Returns

OpenAIConversationAdapter

Methods

filterMessagesForOpenAI

filterMessagesForOpenAI(messages): UniversalMessage[]

Filter messages for OpenAI compatibility

OpenAI has specific requirements:

  • Tool messages must have valid toolCallId
  • Messages must be in proper sequence
  • Tool messages without toolCallId should be excluded

Parameters

NameType
messagesUniversalMessage[]

Returns

UniversalMessage[]

Defined in

adapter.ts:44


toOpenAIFormat

toOpenAIFormat(messages): ChatCompletionMessageParam[]

Convert UniversalMessage array to OpenAI message format Now properly handles tool messages for OpenAI's tool calling feature

Parameters

NameType
messagesUniversalMessage[]

Returns

ChatCompletionMessageParam[]

Defined in

adapter.ts:68


convertMessage

convertMessage(msg): ChatCompletionMessageParam

Convert a single UniversalMessage to OpenAI format Handles all message types including tool messages

Parameters

NameType
msgUniversalMessage

Returns

ChatCompletionMessageParam

Defined in

adapter.ts:78


addSystemPromptIfNeeded

addSystemPromptIfNeeded(messages, systemPrompt?): ChatCompletionMessageParam[]

Add system prompt to message array if needed

Parameters

NameType
messagesChatCompletionMessageParam[]
systemPrompt?string

Returns

ChatCompletionMessageParam[]

Defined in

adapter.ts:153

Released under the MIT License.