Skip to main content

OpenAILLM

OpenAI large language model (LLM).

Constructor

apiKey
string
OpenAI API key. Defaults to the OPENAI_API_KEY environment variable.
model
OpenAILLMModel | string
Model id. Default 'gpt-5.4-nano'.
temperature
number
Sampling temperature; higher is more random. Default 0.7.
maxOutputTokens
number
Maximum number of tokens to generate. Default 1024.
topP
number | null
Nucleus sampling probability mass (0-1). Default null.
frequencyPenalty
number | null
Penalizes new tokens by their frequency so far (-2.0 to 2.0). Default null.
presencePenalty
number | null
Penalizes new tokens by whether they appear so far (-2.0 to 2.0). Default null.
seed
number | null
Seed for deterministic sampling. Default null.
responseFormat
Record<string, any> | null
Output format specification, e.g. { type: 'json_object' }. Default null.
toolChoice
string | null
Controls tool selection, e.g. 'none', 'auto', 'required', or a tool name. Default null.
parallelToolCalls
boolean | null
Whether to allow multiple tool calls to run in parallel. Default null.
stop
string | null
Stop sequence(s) at which generation halts. Default null.
user
string | null
Stable identifier for the end user, used for abuse monitoring. Default null.
reasoningEffort
string | null
Reasoning effort for reasoning-capable models, e.g. 'none', 'low', 'medium', 'high'. Default null.
verbosity
string | null
Response verbosity for capable models, e.g. 'low', 'medium', 'high'. Default null.
streaming
boolean
Stream tokens from the model. Default false.
wssUrl
string | null
Override the realtime websocket URL. Default null.
store
boolean
Whether OpenAI may store the request/response for later retrieval. Default true.

cancelCurrentGeneration

Cancel the in-flight generation for the current session, if any.

chat

Stream a completion for the given messages, yielding LLMResponse chunks.
returns
AsyncIterator<LLMResponse>

close

Release any resources held by the provider.

closeEmitter

Close the emitter: drop all handlers and stop emitting. Waits up to 2 seconds for in-flight async handlers to settle before returning.

emit

event
string
required

getRuntimeConfig

returns
Record<string, any>

listenerCount

event
string
required
returns
number

off

event
string
required
handler
EventHandler
required

on

event
string
required
handler
EventHandler
required
returns
EventHandler

once

event
string
required
handler
EventHandler
required
returns
EventHandler

removeAllListeners

event
string

OpenAILLMModel

Supported OpenAI LLM model ids.