Class GPTLiveModel

OpenAI GPT-Live full-duplex voice model, ready to pass to AgentSession.

Hierarchy (view full)

DuplexModel
- GPTLiveModel

Index

Constructors

Properties

Accessors

Methods

audioGate close label session

Constructors

constructor

new GPTLiveModel(options?): GPTLiveModel
Configure a voice model. Throws when no OpenAI API key is available.
Parameters
- options: GPTLiveModelOptions = {}
Returns GPTLiveModel
Overrides DuplexModel.constructor
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:120

Properties

`Readonly` capabilities

capabilities: DuplexCapabilities

Provider features used to configure the realtime adapter.

Accessors

model

get model(): string
Voice model identifier used for sessions and metrics.

Returns string
Overrides llm.DuplexModel.model
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:145

provider

get provider(): string
Host of the configured API endpoint.

Returns string
Overrides llm.DuplexModel.provider
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:149

Methods

audioGate

audioGate(): AudioGate
Keep output active through short pauses in speech.

Returns AudioGate
Overrides DuplexModel.audioGate
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:154

close

close(): Promise<void>
The model owns no shared resources. Close each session to release its connection.

Returns Promise<void>
Overrides DuplexModel.close
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:163

label

label(): string
Display label used in logs and metrics.

Returns string
Inherited from DuplexModel.label
- Defined in agents/dist/llm/duplex.d.ts:56

session

session(): GPTLiveSession
Create a connection that starts after the framework configures the session.

Returns GPTLiveSession
Overrides DuplexModel.session
- Defined in plugins/openai/src/realtime/gpt_live_model.ts:159