Class TaskGroup

Hierarchy (view full)

AgentTask<TaskGroupResult>
- TaskGroup

Index

Constructors

constructor

new TaskGroup(options?): TaskGroup
Parameters
- options: TaskGroupOptions = {}
Returns TaskGroup
Overrides AgentTask.constructor
- Defined in agents/src/beta/workflows/task_group.ts:49

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: voice.Agent<any>
  - chatCtx: ChatContext
  - toolCtx: ToolContext
  - modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | ChatChunk>>
  - Defined in agents/src/voice/agent.ts:378
realtimeAudioOutputNode:function
- realtimeAudioOutputNode(_agent, audio, _modelSettings): Promise<null | ReadableStream<AudioFrame>>
- Parameters
  - _agent: voice.Agent<any>
  - audio: ReadableStream<AudioFrame>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<AudioFrame>>
  - Defined in agents/src/voice/agent.ts:490
sttNode:function
- sttNode(agent, audio, _modelSettings): Promise<null | ReadableStream<string | SpeechEvent>>
- Parameters
  - agent: voice.Agent<any>
  - audio: ReadableStream<AudioFrame>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | SpeechEvent>>
  - Defined in agents/src/voice/agent.ts:317
transcriptionNode:function
- transcriptionNode(agent, text, _modelSettings): Promise<null | ReadableStream<string | TimedString>>
- Parameters
  - agent: voice.Agent<any>
  - text: ReadableStream<string | TimedString>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<string | TimedString>>
  - Defined in agents/src/voice/agent.ts:482
ttsNode:function
- ttsNode(agent, text, _modelSettings): Promise<null | ReadableStream<AudioFrame>>
- Parameters
  - agent: voice.Agent<any>
  - text: ReadableStream<string>
  - _modelSettings: ModelSettings
  Returns Promise<null | ReadableStream<AudioFrame>>
  - Defined in agents/src/voice/agent.ts:431

Accessors

chatCtx

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

done

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

id

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

instructions

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

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:213

session

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

stt

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

toolCtx

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

tts

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

useTtsAlignedTranscript

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

vad

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

Methods

add

add(task, __namedParameters): this
Parameters
- task: (() => AgentTask<unknown, any>)
  - - (): AgentTask<unknown, any>
    - Returns AgentTask<unknown, any>
- __namedParameters: {
  description: string;
  id: string;
  }
  - description: string
  - id: string
Returns this
- Defined in agents/src/beta/workflows/task_group.ts:59

complete

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

getActivityOrThrow

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

llmNode

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

onEnter

onEnter(): Promise<void>
Returns Promise<void>
Overrides AgentTask.onEnter
- Defined in agents/src/beta/workflows/task_group.ts:64

onExit

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

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:256

realtimeAudioOutputNode

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

run

run(): Promise<TaskGroupResult>
Returns Promise<TaskGroupResult>
Inherited from AgentTask.run
- Defined in agents/src/voice/agent.ts:527

sttNode

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

transcriptionNode

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

ttsNode

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

updateChatCtx

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

updateTools

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

Class TaskGroup

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TaskGroup

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

llm

Returns undefined | llm.LLM | llm.RealtimeModel

session

Returns AgentSession<UserData>

stt

Returns undefined | stt.STT

toolCtx

Returns ToolContext<UserData>

tts

Returns undefined | tts.TTS

useTtsAlignedTranscript

Returns undefined | boolean

vad

Returns undefined | VAD

Methods

add

Parameters

Returns AgentTask<unknown, any>

description: string

id: string

Returns this

complete

Parameters

Returns void

getActivityOrThrow

Returns AgentActivity

llmNode

Parameters

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

onEnter

Returns Promise<void>

onExit

Returns Promise<void>

onUserTurnCompleted

Parameters

Returns Promise<void>

realtimeAudioOutputNode

Parameters

Returns Promise<null | ReadableStream<AudioFrame>>

run

Returns Promise<TaskGroupResult>

sttNode

`Static` default