Interface AgentCreateOptions<UserData>

interface AgentCreateOptions<UserData> {
    allowInterruptions?: boolean;
    chatCtx?: ChatContext;
    expressive?: boolean | ExpressiveOptions;
    id?: string;
    instructions: string | Instructions;
    llm?: null | llm.LLM | llm.RealtimeModel | LLMModels;
    llmNode?: ((ctx, chatCtx, toolCtx, modelSettings) => AgentHookNodeResult<string | ChatChunk>);
    minConsecutiveSpeechDelay?: number;
    onEnter?: ((ctx) => void | Promise<void>);
    onExit?: ((ctx) => void | Promise<void>);
    onUserTurnCompleted?: ((ctx, chatCtx, newMessage) => void | Promise<void>);
    realtimeAudioOutputNode?: ((ctx, audio, modelSettings) => AgentHookNodeResult<AudioFrame>);
    stt?: null | stt.STT | STTModelString;
    sttNode?: ((ctx, audio, modelSettings) => AgentHookNodeResult<string | SpeechEvent>);
    toolHandling?: ToolHandlingOptions;
    tools?: ToolContextLike<UserData>;
    transcriptionNode?: ((ctx, text, modelSettings) => AgentHookNodeResult<string | TimedString>);
    tts?: null | tts.TTS | TTSModelString;
    ttsNode?: ((ctx, text, modelSettings) => AgentHookNodeResult<AudioFrame>);
    turnDetection?: TurnDetectionMode;
    turnHandling?: TurnHandlingOptions;
    useTtsAlignedTranscript?: boolean;
    vad?: null | VAD;
}

Type Parameters

  • UserData = any

Hierarchy (view full)

Properties

allowInterruptions? chatCtx? expressive? id? instructions llm? llmNode? minConsecutiveSpeechDelay? onEnter? onExit? onUserTurnCompleted? realtimeAudioOutputNode? stt? sttNode? toolHandling? tools? transcriptionNode? tts? ttsNode? turnDetection? turnHandling? useTtsAlignedTranscript? vad?

Properties

Optional allowInterruptions

allowInterruptions?: boolean

Deprecated

use turnHandling.interruption.enabled instead

Optional chatCtx

chatCtx?: ChatContext

Optional expressive

expressive?: boolean | ExpressiveOptions

Expressive TTS delivery. When set, overrides the session value for this agent.

Optional id

id?: string

instructions

instructions: string | Instructions

Optional llm

llm?: null | llm.LLM | llm.RealtimeModel | LLMModels

Optional llmNode

llmNode?: ((ctx, chatCtx, toolCtx, modelSettings) => AgentHookNodeResult<string | ChatChunk>)

Produces LLM chunks or text from the current chat and tool context.

Type declaration

Optional minConsecutiveSpeechDelay

minConsecutiveSpeechDelay?: number

Optional onEnter

onEnter?: ((ctx) => void | Promise<void>)

Called when the agent becomes active in a session.

Type declaration

Optional onExit

onExit?: ((ctx) => void | Promise<void>)

Called when the agent is leaving the active session.

Type declaration

Optional onUserTurnCompleted

onUserTurnCompleted?: ((ctx, chatCtx, newMessage) => void | Promise<void>)

Called after the user's turn has been committed to the chat context.

Type declaration

Optional realtimeAudioOutputNode

realtimeAudioOutputNode?: ((ctx, audio, modelSettings) => AgentHookNodeResult<AudioFrame>)

Processes realtime model audio before it is sent to the agent output.

Type declaration

Optional stt

stt?: null | stt.STT | STTModelString

Optional sttNode

sttNode?: ((ctx, audio, modelSettings) => AgentHookNodeResult<string | SpeechEvent>)

Transforms incoming audio into speech events or transcript text for the agent.

Type declaration

Optional toolHandling

toolHandling?: ToolHandlingOptions

Optional tools

tools?: ToolContextLike<UserData>

Optional transcriptionNode

transcriptionNode?: ((ctx, text, modelSettings) => AgentHookNodeResult<string | TimedString>)

Transforms the agent's output transcript before it is forwarded.

Type declaration

Optional tts

tts?: null | tts.TTS | TTSModelString

Optional ttsNode

ttsNode?: ((ctx, text, modelSettings) => AgentHookNodeResult<AudioFrame>)

Synthesizes agent text into audio frames for playout.

Type declaration

Optional turnDetection

turnDetection?: TurnDetectionMode

Deprecated

use turnHandling.turnDetection instead

Optional turnHandling

turnHandling?: TurnHandlingOptions

Optional useTtsAlignedTranscript

useTtsAlignedTranscript?: boolean

Optional vad

vad?: null | VAD

Settings

Member Visibility

Theme

On This Page

allowInterruptionschatCtxexpressiveidinstructionsllmllmNodeminConsecutiveSpeechDelayonEnteronExitonUserTurnCompletedrealtimeAudioOutputNodesttsttNodetoolHandlingtoolstranscriptionNodettsttsNodeturnDetectionturnHandlinguseTtsAlignedTranscriptvad