OpenAIResponses
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:49
Extends
Section titled “Extends”ToolCallLLM<OpenAIResponsesChatOptions>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OpenAIResponses(
init?):OpenAIResponses
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:76
Parameters
Section titled “Parameters”Omit<Partial<OpenAIResponses>, "session"> & object
Returns
Section titled “Returns”OpenAIResponses
Overrides
Section titled “Overrides”ToolCallLLM<OpenAIResponsesChatOptions>.constructor
Properties
Section titled “Properties”model:
string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:50
temperature
Section titled “temperature”temperature:
number
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:51
topP:
number
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:52
maxOutputTokens?
Section titled “maxOutputTokens?”
optionalmaxOutputTokens:number
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:53
additionalChatOptions?
Section titled “additionalChatOptions?”
optionaladditionalChatOptions:OpenAIResponsesChatOptions
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:54
reasoningEffort?
Section titled “reasoningEffort?”
optionalreasoningEffort:"low"|"medium"|"high"
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:55
apiKey?
Section titled “apiKey?”
optionalapiKey:string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:56
baseURL?
Section titled “baseURL?”
optionalbaseURL:string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:57
maxRetries
Section titled “maxRetries”maxRetries:
number
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:58
timeout?
Section titled “timeout?”
optionaltimeout:number
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:59
additionalSessionOptions?
Section titled “additionalSessionOptions?”
optionaladditionalSessionOptions:Omit<Partial<ClientOptions>,"apiKey"|"maxRetries"|"timeout">
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:60
lazySession()
Section titled “lazySession()”lazySession: () =>
Promise<LLMInstance>
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:64
Returns
Section titled “Returns”Promise<LLMInstance>
trackPreviousResponses
Section titled “trackPreviousResponses”trackPreviousResponses:
boolean
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:65
store:
boolean
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:66
user:
string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:67
callMetadata
Section titled “callMetadata”callMetadata:
StoredValue
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:68
builtInTools
Section titled “builtInTools”builtInTools:
null|Tool[]
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:69
strict
Section titled “strict”strict:
boolean
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:70
include
Section titled “include”include:
null|ResponseIncludable[]
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:71
instructions
Section titled “instructions”instructions:
string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:72
previousResponseId
Section titled “previousResponseId”previousResponseId:
null|string
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:73
truncation
Section titled “truncation”truncation:
null|"auto"|"disabled"
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:74
Accessors
Section titled “Accessors”session
Section titled “session”Get Signature
Section titled “Get Signature”get session():
Promise<LLMInstance>
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:127
Returns
Section titled “Returns”Promise<LLMInstance>
supportToolCall
Section titled “supportToolCall”Get Signature
Section titled “Get Signature”get supportToolCall():
boolean
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:134
Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”ToolCallLLM.supportToolCall
metadata
Section titled “metadata”Get Signature
Section titled “Get Signature”get metadata():
LLMMetadata&object
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:138
Returns
Section titled “Returns”LLMMetadata & object
Overrides
Section titled “Overrides”ToolCallLLM.metadata
Methods
Section titled “Methods”chat()
Section titled “chat()”Call Signature
Section titled “Call Signature”chat(
params):Promise<AsyncIterable<ChatResponseChunk<OpenAIResponsesMessageOptions>,any,any>>
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:544
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsStreaming<OpenAIResponsesChatOptions, OpenAIResponsesMessageOptions>
Returns
Section titled “Returns”Promise<AsyncIterable<ChatResponseChunk<OpenAIResponsesMessageOptions>, any, any>>
Overrides
Section titled “Overrides”ToolCallLLM.chat
Call Signature
Section titled “Call Signature”chat(
params):Promise<ChatResponse<OpenAIResponsesMessageOptions>>
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:550
Parameters
Section titled “Parameters”params
Section titled “params”LLMChatParamsNonStreaming<OpenAIResponsesChatOptions, OpenAIResponsesMessageOptions>
Returns
Section titled “Returns”Promise<ChatResponse<OpenAIResponsesMessageOptions>>
Overrides
Section titled “Overrides”ToolCallLLM.chat
streamChat()
Section titled “streamChat()”
protectedstreamChat(baseRequestParams):AsyncIterable<ChatResponseChunk<OpenAIResponsesMessageOptions>>
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:636
Parameters
Section titled “Parameters”baseRequestParams
Section titled “baseRequestParams”ResponseCreateParams
Returns
Section titled “Returns”AsyncIterable<ChatResponseChunk<OpenAIResponsesMessageOptions>>
toOpenAIResponsesRole()
Section titled “toOpenAIResponsesRole()”toOpenAIResponsesRole(
messageType):OpenAIResponsesRole
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:655
Parameters
Section titled “Parameters”messageType
Section titled “messageType”MessageType
Returns
Section titled “Returns”OpenAIResponsesRole
toOpenAIResponseMessage()
Section titled “toOpenAIResponseMessage()”toOpenAIResponseMessage(
message):ResponseInputItem|ResponseInputItem[]
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:778
Parameters
Section titled “Parameters”message
Section titled “message”ChatMessage<OpenAIResponsesMessageOptions>
Returns
Section titled “Returns”ResponseInputItem | ResponseInputItem[]
toOpenAIResponseMessages()
Section titled “toOpenAIResponseMessages()”toOpenAIResponseMessages(
messages):ResponseInput
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:796
Parameters
Section titled “Parameters”messages
Section titled “messages”ChatMessage<OpenAIResponsesMessageOptions>[]
Returns
Section titled “Returns”ResponseInput
toResponsesTool()
Section titled “toResponsesTool()”toResponsesTool(
tool):Tool
Defined in: .build/typescript/packages/providers/openai/src/responses.ts:811
Parameters
Section titled “Parameters”BaseTool
Returns
Section titled “Returns”Tool