Class Agent<UserData>

constructor

• new Agent<UserData>(__namedParameters): voice.Agent<UserData>

• Type Parameters

  • UserData = any

  Parameters

  • __namedParameters: AgentOptions<UserData>

  Returns voice.Agent<UserData>

Static default

chatCtx

• get chatCtx(): ReadonlyChatContext

• Returns ReadonlyChatContext

instructions

• get instructions(): string

• Returns string

llm

• get llm(): undefined | llm.LLM | llm.RealtimeModel

• Returns undefined | llm.LLM | llm.RealtimeModel

session

• get session(): AgentSession<UserData>

• Returns AgentSession<UserData>

stt

• get stt(): undefined | stt.STT

• Returns undefined | stt.STT

toolCtx

• get toolCtx(): ToolContext<UserData>

• Returns ToolContext<UserData>

tts

• get tts(): undefined | tts.TTS

• Returns undefined | tts.TTS

vad

• get vad(): undefined | VAD

• Returns undefined | VAD

getActivityOrThrow

• getActivityOrThrow(): AgentActivity

• Returns AgentActivity

llmNode

• llmNode(chatCtx, toolCtx, modelSettings): Promise<null | ReadableStream<string | ChatChunk>>

• Parameters

  • chatCtx: ChatContext
  • toolCtx: ToolContext
  • modelSettings: ModelSettings

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

onEnter

• onEnter(): Promise<void>

• Returns Promise<void>

onExit

• onExit(): Promise<void>

• Returns Promise<void>

onUserTurnCompleted

• onUserTurnCompleted(_chatCtx, _newMessage): Promise<void>

• Parameters

  • _chatCtx: ChatContext
  • _newMessage: ChatMessage

  Returns Promise<void>

realtimeAudioOutputNode

• realtimeAudioOutputNode(audio, modelSettings): Promise<null | ReadableStream<AudioFrame>>

• Parameters

  • audio: ReadableStream<AudioFrame>
  • modelSettings: ModelSettings

  Returns Promise<null | ReadableStream<AudioFrame>>

sttNode

• sttNode(audio, modelSettings): Promise<null | ReadableStream<string | SpeechEvent>>

• Parameters

  • audio: ReadableStream<AudioFrame>
  • modelSettings: ModelSettings

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

transcriptionNode

• transcriptionNode(text, modelSettings): Promise<null | ReadableStream<string>>

• Parameters

  • text: ReadableStream<string>
  • modelSettings: ModelSettings

  Returns Promise<null | ReadableStream<string>>

ttsNode

• ttsNode(text, modelSettings): Promise<null | ReadableStream<AudioFrame>>

• Parameters

  • text: ReadableStream<string>
  • modelSettings: ModelSettings

  Returns Promise<null | ReadableStream<AudioFrame>>

updateChatCtx

• updateChatCtx(chatCtx): Promise<void>

• Parameters

  • chatCtx: ChatContext

  Returns Promise<void>