Class GPTLiveSession

GPT-Live WebSocket session, accessible through Agent.duplexSession. Also emits openai_server_event_received, openai_client_event_queued and delegation_created. Append methods queue context without waiting for acknowledgment. The appended events arrive at the estimated context-injection end and do not indicate speech completion.

Hierarchy (view full)

DuplexSession<{
    delegation_created: ((event) => void);
    openai_client_event_queued: ((event) => void);
    openai_server_event_received: ((event) => void);
}>
- GPTLiveSession

Index

Constructors

constructor

new GPTLiveSession(model): GPTLiveSession
Create a session using a copy of the model configuration.
Parameters
- model: GPTLiveModel
Returns GPTLiveSession
Overrides DuplexSession.constructor
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:234

Properties

`Readonly` duplexModel

duplexModel: DuplexModel

Model that created this session.

Accessors

audioStream

get audioStream(): ReadableStream<DuplexAudioFrame>
Mono 24 kHz PCM output, retained across reconnects and closed on shutdown.

Returns ReadableStream<DuplexAudioFrame>
Overrides llm.DuplexSession.audioStream
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:250

capabilities

get capabilities(): DuplexCapabilities
Provider features declared by the owning model.

Returns DuplexCapabilities
Inherited from llm.DuplexSession.capabilities
- Defined in agents/dist/llm/duplex.d.ts:106

sessionId

get sessionId(): undefined | string
Provider session identifier. Changes when a replacement connection starts.

Returns undefined | string
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:246

tools

get tools(): ToolContext<unknown>
Copy of the tools available to the backend Responses model.

Returns ToolContext<unknown>
Overrides llm.DuplexSession.tools
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:254

Methods

_appendItems

_appendItems(items): Promise<void>
Retain framework chat items for reconnects and send their context or tool results.
Parameters
- items: ChatItem[]
Returns Promise<void>
Overrides DuplexSession._appendItems
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:952

_generateReply

_generateReply(instructions?): void
Prompt an immediate spoken reply to instructions or the newest typed user message.
Parameters
- Optional instructions: string
Returns void
Overrides DuplexSession._generateReply
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:986

_updateInstructions

_updateInstructions(instructions): Promise<void>
Set the initial voice instructions. Changes after session.start are rejected.
Parameters
- instructions: string
Returns Promise<void>
Overrides DuplexSession._updateInstructions
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:927

_updateOptions

_updateOptions(options): void
Update backend tool selection for this session and future reconnects.
Parameters
- options: {
  toolChoice?: null | llm.ToolChoice;
  }
  - Optional toolChoice?: null | llm.ToolChoice
Returns void
Overrides DuplexSession._updateOptions
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:1003

_updateSession

_updateSession(instructions?, chatCtx?, tools?): Promise<void>
Apply the complete startup configuration before releasing a waiting provider connection.
Parameters
- Optional instructions: string
- Optional chatCtx: ChatContext
- Optional tools: ToolContext<unknown>
Returns Promise<void>
Inherited from DuplexSession._updateSession
- Defined in agents/dist/llm/duplex.d.ts:135

_updateTools

_updateTools(tools): Promise<void>
Update backend tools. Client delegation requires an empty tool context.
Parameters
- tools: ToolContext<unknown>
Returns Promise<void>
Overrides DuplexSession._updateTools
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:936

appendCommentary

appendCommentary(text, options?): void
Give the model text to paraphrase aloud, or answer a client delegation. Capped at 500 tokens by the service.
Parameters
- text: string
- options: {
  delegationId?: null | string;
  } = {}
  - Optional delegationId?: null | string
Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:877

appendInstructions

appendInstructions(text, options?): void
Add a standing rule retained in reconnect history. The service caps each append at 500 tokens.
Parameters
- text: string
- options: {
  delegationId?: null | string;
  } = {}
  - Optional delegationId?: null | string
Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:867

appendThinking

appendThinking(text, options?): void
Add silent context retained in reconnect history. The service caps each append at 500 tokens.
Parameters
- text: string
- options: {
  delegationId?: null | string;
  } = {}
  - Optional delegationId?: null | string
Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:873

close

close(): Promise<void>
Mark the session closing, release configuration waits, and close provider resources.

Returns Promise<void>
Inherited from DuplexSession.close
- Defined in agents/dist/llm/duplex.d.ts:116

muteInput

muteInput(): void
Replace microphone input with silence while the model continues speaking.

Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:902

pushAudio

pushAudio(frame): void
Buffer microphone audio, mixing to mono and resampling to 24 kHz as needed.
Parameters
- frame: AudioFrame
Returns void
Overrides DuplexSession.pushAudio
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:819

pushVideo

pushVideo(_frame): void
Feed an input video frame. Providers without video input can ignore it.
Parameters
- _frame: VideoFrame
Returns void
Inherited from DuplexSession.pushVideo
- Defined in agents/dist/llm/duplex.d.ts:114

sendEvent

sendEvent(event): void
Queue a wire event. Commands wait for session.started before being sent.
Parameters
- event: Record<string, unknown> | realtime.GPTLive.ClientEvent
Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:259

unmuteInput

unmuteInput(): void
Restore microphone input.

Returns void
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:909

Class GPTLiveSession

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GPTLiveSession

Properties

Readonly duplexModel

Accessors

audioStream

Returns ReadableStream<DuplexAudioFrame>

capabilities

Returns DuplexCapabilities

sessionId

Returns undefined | string

tools

Returns ToolContext<unknown>

Methods

_appendItems

Parameters

Returns Promise<void>

_generateReply

Parameters

Returns void

_updateInstructions

Parameters

Returns Promise<void>

_updateOptions

Parameters

Optional toolChoice?: null | llm.ToolChoice

Returns void

_updateSession

Parameters

Returns Promise<void>

_updateTools

Parameters

Returns Promise<void>

appendCommentary

Parameters

Optional delegationId?: null | string

Returns void

appendInstructions

Parameters

Optional delegationId?: null | string

Returns void

appendThinking

Parameters

Optional delegationId?: null | string

Returns void

close

Returns Promise<void>

muteInput

Returns void

pushAudio

Parameters

Returns void

pushVideo

Parameters

Returns void

sendEvent

Parameters

Returns void

unmuteInput

Returns void

Settings

Member Visibility

Theme

On This Page

`Readonly` duplexModel

`Optional` toolChoice?: null | llm.ToolChoice

`Optional` delegationId?: null | string

`Optional` delegationId?: null | string

`Optional` delegationId?: null | string