Class RealtimeSession`Abstract`

Hierarchy

EventEmitter
- RealtimeSession

Index

Constructors

Accessors

chatCtx realtimeModel tools

Methods

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

Accessors

`Abstract` chatCtx

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

realtimeModel

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

`Abstract` tools

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

Methods

`Abstract` clearAudio

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

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

close

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

`Abstract` commitAudio

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

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

`Abstract` generateReply

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

`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:131

`Abstract` pushAudio

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

setInputAudioStream

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

startUserActivity

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

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

`Abstract` truncate

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

`Abstract` updateChatCtx

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

`Abstract` updateInstructions

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

`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:109

`Abstract` updateTools

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