Skip to main content

AzureOpenAILLM

Azure OpenAI large language model provider. Creates a configured Azure OpenAI LLM provider for use in a voice agent.

Constructor

apiKey
string | null
Azure OpenAI API key. Falls back to the AZURE_OPENAI_API_KEY env var, then null.
azureEndpoint
string | null
Azure OpenAI resource endpoint. Falls back to the AZURE_OPENAI_ENDPOINT env var, then null.
deployment
AzureOpenAILLMModel | string | null
Azure deployment name (used as the model). Default: ''.
apiVersion
string
Azure OpenAI REST API version. Default: '2024-10-21'.
temperature
number
Sampling temperature. Range 0-2. Default: 0.7.
maxOutputTokens
number
Maximum number of tokens to generate. Default: 1024.
topP
number | null
Nucleus sampling probability mass. Default: null.
frequencyPenalty
number | null
Frequency penalty. Range -2-2. Default: null.
presencePenalty
number | null
Presence penalty. Range -2-2. Default: null.
seed
number | null
Sampling seed for reproducible outputs. Default: null.
stop
string | null
Stop sequence(s). Default: null.
user
string | null
Opaque end-user identifier. Default: null.
toolChoice
string | null
Tool-selection strategy, e.g. 'auto', 'none'. Default: null.
parallelToolCalls
boolean | null
Whether to allow parallel tool calls. Default: null.
responseFormat
Record<string, any> | null
Response format object, e.g. JSON mode. Default: null.
reasoningEffort
string | null
Reasoning effort level for reasoning models. Default: null.

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

AzureOpenAILLMModel

Supported Azure OpenAI LLM deployment model names.