Class WarmTransferTask

Class wrapper around createWarmTransferTask, preserving the new WarmTransferTask(options).run() API. It composes the functional task and delegates run() to it.

Hierarchy (view full)

AgentTask<WarmTransferResult>
- WarmTransferTask

Constructors

constructor

new WarmTransferTask(options?): WarmTransferTask
Parameters
- options: WarmTransferTaskOptions = {}
Returns WarmTransferTask
Overrides AgentTask.constructor
- Defined in agents/src/workflows/warm_transfer.ts:482

Properties

`Static` default

default: {
    llmNode(agent, chatCtx, toolCtx, modelSettings): Promise<null | ReadableStream<string | ChatChunk>>;
    realtimeAudioOutputNode(_agent, audio, _modelSettings): Promise<null | ReadableStream<AudioFrame>>;
    sttNode(agent, audio, _modelSettings): Promise<null | ReadableStream<string | SpeechEvent>>;
    transcriptionNode(agent, text, _modelSettings): Promise<null | ReadableStream<string | TimedString>>;
    ttsNode(agent, text, _modelSettings): Promise<null | ReadableStream<AudioFrame>>;
} = ...

Type declaration

llmNode:function
- llmNode(agent, chatCtx, toolCtx, modelSettings): Promise<null | ReadableStream<string | ChatChunk>>
- Parameters
  - agent: Agent<any>
  - chatCtx: ChatContext
  - toolCtx: ToolContext<unknown>
  - modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | ChatChunk>>
  - Defined in agents/src/voice/agent.ts:461
realtimeAudioOutputNode:function
- realtimeAudioOutputNode(_agent, audio, _modelSettings): Promise<null | ReadableStream<AudioFrame>>
- Parameters
  - _agent: Agent<any>
  - audio: ReadableStream<AudioFrame> | AsyncIterable<AudioFrame, any, any>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<AudioFrame>>
  - Defined in agents/src/voice/agent.ts:578
sttNode:function
- sttNode(agent, audio, _modelSettings): Promise<null | ReadableStream<string | SpeechEvent>>
- Parameters
  - agent: Agent<any>
  - audio: ReadableStream<AudioFrame> | AsyncIterable<AudioFrame, any, any>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | SpeechEvent>>
  - Defined in agents/src/voice/agent.ts:398
transcriptionNode:function
- transcriptionNode(agent, text, _modelSettings): Promise<null | ReadableStream<string | TimedString>>
- Parameters
  - agent: Agent<any>
  - text: ReadableStream<string | TimedString> | AsyncIterable<string | TimedString, any, any>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | TimedString>>
  - Defined in agents/src/voice/agent.ts:570
ttsNode:function
- ttsNode(agent, text, _modelSettings): Promise<null | ReadableStream<AudioFrame>>
- Parameters
  - agent: Agent<any>
  - text: ReadableStream<string> | AsyncIterable<string, any, any>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<AudioFrame>>
  - Defined in agents/src/voice/agent.ts:514

Accessors

chatCtx

get chatCtx(): ReadonlyChatContext
Returns ReadonlyChatContext
Inherited from AgentTask.chatCtx
- Defined in agents/src/voice/agent.ts:277

done

get done(): boolean
Returns boolean
Inherited from AgentTask.done
- Defined in agents/src/voice/agent.ts:611

id

get id(): string
Returns string
Inherited from AgentTask.id
- Defined in agents/src/voice/agent.ts:281

instructions

get instructions(): string | Instructions
Returns string | Instructions
Inherited from AgentTask.instructions
- Defined in agents/src/voice/agent.ts:285

llm

get llm(): undefined | llm.LLM | llm.RealtimeModel
Returns undefined | llm.LLM | llm.RealtimeModel
Inherited from AgentTask.llm
- Defined in agents/src/voice/agent.ts:265

minConsecutiveSpeechDelay

get minConsecutiveSpeechDelay(): undefined | number
Returns undefined | number
Inherited from AgentTask.minConsecutiveSpeechDelay
- Defined in agents/src/voice/agent.ts:301

session

get session(): AgentSession<UserData>
Returns AgentSession<UserData>
Inherited from AgentTask.session
- Defined in agents/src/voice/agent.ts:293

stt

get stt(): undefined | stt.STT
Returns undefined | stt.STT
Inherited from AgentTask.stt
- Defined in agents/src/voice/agent.ts:261

toolCtx

get toolCtx(): ToolContext<UserData>
Returns ToolContext<UserData>
Inherited from AgentTask.toolCtx
- Defined in agents/src/voice/agent.ts:289

tts

get tts(): undefined | tts.TTS
Returns undefined | tts.TTS
Inherited from AgentTask.tts
- Defined in agents/src/voice/agent.ts:269

turnHandling

get turnHandling(): undefined | Partial<TurnHandlingOptions>
Returns undefined | Partial<TurnHandlingOptions>
Inherited from AgentTask.turnHandling
- Defined in agents/src/voice/agent.ts:297

useTtsAlignedTranscript

get useTtsAlignedTranscript(): undefined | boolean
Returns undefined | boolean
Inherited from AgentTask.useTtsAlignedTranscript
- Defined in agents/src/voice/agent.ts:273

vad

get vad(): undefined | VAD
Returns undefined | VAD
Inherited from AgentTask.vad
- Defined in agents/src/voice/agent.ts:257

Methods

complete

complete(result): void
Parameters
- result: Error | WarmTransferResult
Returns void
Inherited from AgentTask.complete
- Defined in agents/src/voice/agent.ts:615

getActivityOrThrow

getActivityOrThrow(): AgentActivity
Returns AgentActivity
Inherited from AgentTask.getActivityOrThrow
- Defined in agents/src/voice/agent.ts:361

llmNode

llmNode(chatCtx, toolCtx, modelSettings): Promise<null | ReadableStream<string | typeof FlushSentinel | ChatChunk>>
Parameters
- chatCtx: ChatContext
- toolCtx: ToolContext<unknown>
- modelSettings: ModelSettings
Returns Promise<null | ReadableStream<string | typeof FlushSentinel | ChatChunk>>
Inherited from AgentTask.llmNode
- Defined in agents/src/voice/agent.ts:337

onEnter

onEnter(): Promise<void>
Returns Promise<void>
Inherited from AgentTask.onEnter
- Defined in agents/src/voice/agent.ts:305

onExit

onExit(): Promise<void>
Returns Promise<void>
Inherited from AgentTask.onExit
- Defined in agents/src/voice/agent.ts:307

onUserTurnCompleted

onUserTurnCompleted(_chatCtx, _newMessage): Promise<void>
Parameters
- _chatCtx: ChatContext
- _newMessage: ChatMessage
Returns Promise<void>
Inherited from AgentTask.onUserTurnCompleted
- Defined in agents/src/voice/agent.ts:316

onUserTurnExceeded

onUserTurnExceeded(ev): Promise<void>
Parameters
- ev: UserTurnExceededEvent
Returns Promise<void>
Inherited from AgentTask.onUserTurnExceeded
- Defined in agents/src/voice/agent.ts:318

realtimeAudioOutputNode

realtimeAudioOutputNode(audio, modelSettings): Promise<null | ReadableStream<AudioFrame>>
Parameters
- audio: ReadableStream<AudioFrame> | AsyncIterable<AudioFrame, any, any>
- modelSettings: ModelSettings
Returns Promise<null | ReadableStream<AudioFrame>>
Inherited from AgentTask.realtimeAudioOutputNode
- Defined in agents/src/voice/agent.ts:352

run

run(): Promise<WarmTransferResult>
Returns Promise<WarmTransferResult>
Overrides AgentTask.run
- Defined in agents/src/workflows/warm_transfer.ts:489

sttNode

sttNode(audio, modelSettings): Promise<null | ReadableStream<string | SpeechEvent>>
Parameters
- audio: ReadableStream<AudioFrame> | AsyncIterable<AudioFrame, any, any>
- modelSettings: ModelSettings
Returns Promise<null | ReadableStream<string | SpeechEvent>>
Inherited from AgentTask.sttNode
- Defined in agents/src/voice/agent.ts:330

transcriptionNode

transcriptionNode(text, modelSettings): Promise<null | ReadableStream<string | TimedString>>
Parameters
- text: ReadableStream<string | TimedString> | AsyncIterable<string | TimedString, any, any>
- modelSettings: ModelSettings
Returns Promise<null | ReadableStream<string | TimedString>>
Inherited from AgentTask.transcriptionNode
- Defined in agents/src/voice/agent.ts:309

ttsNode

ttsNode(text, modelSettings): Promise<null | ReadableStream<AudioFrame>>
Parameters
- text: ReadableStream<string> | AsyncIterable<string, any, any>
- modelSettings: ModelSettings
Returns Promise<null | ReadableStream<AudioFrame>>
Inherited from AgentTask.ttsNode
- Defined in agents/src/voice/agent.ts:345

updateChatCtx

updateChatCtx(chatCtx): Promise<void>
Parameters
- chatCtx: ChatContext
Returns Promise<void>
Inherited from AgentTask.updateChatCtx
- Defined in agents/src/voice/agent.ts:368

updateInstructions

updateInstructions(instructions): Promise<void>
Parameters
- instructions: string | Instructions
Returns Promise<void>
Inherited from AgentTask.updateInstructions
- Defined in agents/src/voice/agent.ts:377

updateTools

updateTools(tools): Promise<void>
Parameters
- tools: ToolContextLike<any>
Returns Promise<void>
Inherited from AgentTask.updateTools
- Defined in agents/src/voice/agent.ts:387

`Static` create

create<ResultT, UserData>(options): AgentTask<ResultT, UserData>
Type Parameters
- ResultT = unknown
- UserData = unknown
Parameters
- options: AgentTaskCreateOptions<ResultT, UserData>
Returns AgentTask<ResultT, UserData>
Inherited from AgentTask.create
- Defined in agents/src/voice/agent.ts:599

Class WarmTransferTask

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WarmTransferTask

Properties

Static default

Type declaration

llmNode:function

Parameters

Returns Promise<null | ReadableStream<string | ChatChunk>>

realtimeAudioOutputNode:function

Parameters

Returns Promise<null | ReadableStream<AudioFrame>>

sttNode:function

Parameters

Returns Promise<null | ReadableStream<string | SpeechEvent>>

transcriptionNode:function

Parameters

Returns Promise<null | ReadableStream<string | TimedString>>

ttsNode:function

Parameters

Returns Promise<null | ReadableStream<AudioFrame>>

Accessors

chatCtx

Returns ReadonlyChatContext

done

Returns boolean

id

Returns string

instructions

Returns string | Instructions

llm

Returns undefined | llm.LLM | llm.RealtimeModel

minConsecutiveSpeechDelay

Returns undefined | number

session

Returns AgentSession<UserData>

stt

Returns undefined | stt.STT

toolCtx

Returns ToolContext<UserData>

tts

Returns undefined | tts.TTS

turnHandling

Returns undefined | Partial<TurnHandlingOptions>

useTtsAlignedTranscript

Returns undefined | boolean

vad

Returns undefined | VAD

Methods

complete

Parameters

Returns void

getActivityOrThrow

Returns AgentActivity

llmNode

Parameters

Returns Promise<null | ReadableStream<string | typeof FlushSentinel | ChatChunk>>

onEnter

Returns Promise<void>

onExit

Returns Promise<void>

onUserTurnCompleted

Parameters

Returns Promise<void>

onUserTurnExceeded

Parameters

Returns Promise<void>

realtimeAudioOutputNode

Parameters

Returns Promise<null | ReadableStream<AudioFrame>>

run

Returns Promise<WarmTransferResult>

`Static` default

`Static` create