Interface AgentOptions<UserData>

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

Type Parameters

UserData

Hierarchy (view full)

AgentOptions
- AgentCreateOptions

Index

Properties

allowInterruptions? chatCtx? expressive? id? instructions llm? minConsecutiveSpeechDelay? stt? toolHandling? tools? tts? 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` minConsecutiveSpeechDelay

minConsecutiveSpeechDelay?: number

`Optional` stt

stt?: null | stt.STT | STTModelString

`Optional` toolHandling

toolHandling?: ToolHandlingOptions

`Optional` tools

tools?: ToolContextLike<UserData>

`Optional` tts

tts?: null | tts.TTS | TTSModelString

`Optional` turnDetection

turnDetection?: TurnDetectionMode

Deprecated

use turnHandling.turnDetection instead

`Optional` turnHandling

turnHandling?: TurnHandlingOptions

`Optional` useTtsAlignedTranscript

useTtsAlignedTranscript?: boolean

`Optional` vad

vad?: null | VAD