Interface AgentOptions<UserData>

interface AgentOptions<UserData> {
    allowInterruptions?: boolean;
    chatCtx?: ChatContext;
    id?: string;
    instructions: string | Instructions;
    llm?: llm.LLM | llm.RealtimeModel | LLMModels;
    minConsecutiveSpeechDelay?: number;
    stt?: stt.STT | STTModelString;
    tools?: ToolContext<UserData>;
    tts?: tts.TTS | TTSModelString;
    ttsPronunciationMap?: TTSPronunciationMap;
    turnDetection?: TurnDetectionMode;
    turnHandling?: TurnHandlingOptions;
    useTtsAlignedTranscript?: boolean;
    vad?: VAD;
}

Type Parameters

  • UserData

Properties

allowInterruptions?: boolean

Deprecated

use turnHandling.interruption.enabled instead

chatCtx?: ChatContext
id?: string
instructions: string | Instructions
minConsecutiveSpeechDelay?: number
ttsPronunciationMap?: TTSPronunciationMap

Text replacements applied before TTS synthesis.

turnDetection?: TurnDetectionMode

Deprecated

use turnHandling.turnDetection instead

turnHandling?: TurnHandlingOptions
useTtsAlignedTranscript?: boolean
vad?: VAD