Interface AgentTaskContext<ResultT, UserData>

Context passed to hooks created with AgentTask.create().

interface AgentTaskContext<ResultT, UserData> {
    agent: AgentTask<ResultT, UserData>;
    chatCtx: ReadonlyChatContext;
    id: string;
    instructions: string | Instructions;
    llm: undefined | llm.LLM | llm.RealtimeModel;
    minConsecutiveSpeechDelay: undefined | number;
    session: AgentSession<UserData>;
    stt: undefined | stt.STT;
    toolCtx: ToolContext<UserData>;
    tts: undefined | tts.TTS;
    turnHandling: undefined | Partial<TurnHandlingOptions>;
    useTtsAlignedTranscript: undefined | boolean;
    vad: undefined | VAD;
    complete(result): void;
}

Type Parameters

  • ResultT = unknown
  • UserData = unknown

Hierarchy (view full)

Properties

agent chatCtx id instructions llm minConsecutiveSpeechDelay session stt toolCtx tts turnHandling useTtsAlignedTranscript vad

Methods

complete

Properties

agent

agent: AgentTask<ResultT, UserData>

The task instance currently running the hook.

chatCtx

chatCtx: ReadonlyChatContext

Readonly view of the agent's current chat context.

id

id: string

Agent identifier.

instructions

instructions: string | Instructions

Agent instructions.

llm

llm: undefined | llm.LLM | llm.RealtimeModel

LLM or realtime model configured for the agent.

minConsecutiveSpeechDelay

minConsecutiveSpeechDelay: undefined | number

Minimum delay between consecutive speech.

session

session: AgentSession<UserData>

Current session for the agent.

stt

stt: undefined | stt.STT

Speech-to-text model configured for the agent.

toolCtx

toolCtx: ToolContext<UserData>

Copy of the agent tool context.

tts

tts: undefined | tts.TTS

Text-to-speech model configured for the agent.

turnHandling

turnHandling: undefined | Partial<TurnHandlingOptions>

Agent-level turn handling configuration.

useTtsAlignedTranscript

useTtsAlignedTranscript: undefined | boolean

Whether TTS-aligned transcripts are enabled for the agent.

vad

vad: undefined | VAD

Voice activity detector configured for the agent.

Methods

complete

Settings

Member Visibility

Theme

On This Page

agentchatCtxidinstructionsllmminConsecutiveSpeechDelaysessionstttoolCtxttsturnHandlinguseTtsAlignedTranscriptvadcomplete