Class RealtimeSession`Abstract`

Hierarchy

EventEmitter
- RealtimeSession

Index

Constructors

Accessors

chatCtx realtimeModel tools

Methods

_updateSession clearAudio close commitAudio generateReply interrupt pushAudio setInputAudioStream startUserActivity truncate updateChatCtx updateInstructions updateOptions updateTools

Constructors

constructor

new RealtimeSession(realtimeModel): llm.RealtimeSession
Parameters
- realtimeModel: llm.RealtimeModel
Returns llm.RealtimeSession
Overrides EventEmitter.constructor
- Defined in agents/src/llm/realtime.ts:97

Accessors

`Abstract` chatCtx

get chatCtx(): ChatContext
Returns ChatContext
- Defined in agents/src/llm/realtime.ts:107

realtimeModel

get realtimeModel(): llm.RealtimeModel
Returns llm.RealtimeModel
- Defined in agents/src/llm/realtime.ts:103

`Abstract` tools

get tools(): ToolContext
Returns ToolContext
- Defined in agents/src/llm/realtime.ts:109

Methods

_updateSession

_updateSession(instructions?, chatCtx?, tools?): Promise<void>
Parameters
- Optional instructions: string
- Optional chatCtx: ChatContext
- Optional tools: ToolContext
Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:154

`Abstract` clearAudio

clearAudio(): Promise<void>
Clear the input audio buffer to the server

Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:137

close

close(): Promise<void>
Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:182

`Abstract` commitAudio

commitAudio(): Promise<void>
Commit the input audio buffer to the server

Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:132

`Abstract` generateReply

generateReply(instructions?): Promise<GenerationCreatedEvent>
Parameters
- Optional instructions: string
Returns Promise<GenerationCreatedEvent>
Throws
RealtimeError on Timeout
- Defined in agents/src/llm/realtime.ts:127

`Abstract` interrupt

interrupt(): Promise<void>
Cancel the current generation (do nothing if no generation is in progress)

Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:142

`Abstract` pushAudio

pushAudio(frame): void
Parameters
- frame: AudioFrame
Returns void
- Defined in agents/src/llm/realtime.ts:122

setInputAudioStream

setInputAudioStream(audioStream): void
Parameters
- audioStream: ReadableStream<AudioFrame>
Returns void
- Defined in agents/src/llm/realtime.ts:205

startUserActivity

startUserActivity(): void
Notifies the model that user activity has started

Returns void
- Defined in agents/src/llm/realtime.ts:190

`Abstract` truncate

truncate(options): Promise<void>
Truncate the message at the given audio end time
Parameters
- options: {
      audioEndMs: number;
      audioTranscript?: string;
      messageId: string;
      modalities?: ("text" | "audio")[];
  }
  - audioEndMs: number
  - Optional audioTranscript?: string
  - messageId: string
  - Optional modalities?: ("text" | "audio")[]
Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:147

`Abstract` updateChatCtx

updateChatCtx(chatCtx): Promise<void>
Parameters
- chatCtx: ChatContext
Returns Promise<void>
Throws
RealtimeError on Timeout
- Defined in agents/src/llm/realtime.ts:116

`Abstract` updateInstructions

updateInstructions(instructions): Promise<void>
Parameters
- instructions: string
Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:111

`Abstract` updateOptions

updateOptions(options): void
Parameters
- options: {
  toolChoice?: null | llm.ToolChoice;
  }
  - Optional toolChoice?: null | llm.ToolChoice
Returns void
- Defined in agents/src/llm/realtime.ts:120

`Abstract` updateTools

updateTools(tools): Promise<void>
Parameters
- tools: ToolContext
Returns Promise<void>
- Defined in agents/src/llm/realtime.ts:118