Class LiveGenerativeModel`Beta`

Class for Live generative model APIs. The Live API enables low-latency, two-way multimodal interactions with Gemini.

This class should only be instantiated with getLiveGenerativeModel.

Hierarchy (View Summary)

AIModel
- LiveGenerativeModel

Index

Constructors

constructor

new LiveGenerativeModel(
    ai: AI,
    modelParams: LiveModelParams,
    _webSocketHandler: WebSocketHandler,
): LiveGenerativeModel
Internal
Parameters
- ai: AI
- modelParams: LiveModelParams
- Internal_webSocketHandler: WebSocketHandler
Returns LiveGenerativeModel
Overrides AIModel.constructor
- Defined in models/live-generative-model.ts:51

Methods

connect

connect(sessionResumption?: SessionResumptionConfig): Promise<LiveSession>
Beta
Starts a LiveSession.
Parameters
- OptionalsessionResumption: SessionResumptionConfig
  Optional configuration for resuming a previous live session.
Returns Promise<LiveSession>
A LiveSession.

Throws
If the connection failed to be established with the server.
- Defined in models/live-generative-model.ts:75

`Static`normalizeModelName

normalizeModelName(modelName: string, backendType: BackendType): string
Internal
Normalizes the given model name to a fully qualified model resource name.
Parameters
- modelName: string
  The model name to normalize.
- backendType: BackendType
Returns string
The fully qualified model resource name.
Inherited from AIModel.normalizeModelName
- Defined in models/ai-model.ts:72

Properties

`Protected` `Internal`_apiSettings

_apiSettings: ApiSettings

`Beta`generationConfig

generationConfig: LiveGenerationConfig

`Readonly`model

model: string

The fully qualified model resource name (for example, gemini-3.1-flash-lite for text or publishers/google/models/gemini-3.1-flash-lite-image for image models).

`Optional` `Beta`systemInstruction

systemInstruction?: Content

`Optional` `Beta`toolConfig

toolConfig?: ToolConfig

`Optional` `Beta`tools

tools?: Tool[]

Class LiveGenerativeModelBeta

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns LiveGenerativeModel

Methods

connect

Parameters

Returns Promise<LiveSession>

Throws

StaticnormalizeModelName

Parameters

Returns string

Properties

Protected Internal_apiSettings

BetagenerationConfig

Readonlymodel

Optional BetasystemInstruction

Optional BetatoolConfig

Optional Betatools

Settings

On This Page

Class LiveGenerativeModel`Beta`

`Static`normalizeModelName

`Protected` `Internal`_apiSettings

`Beta`generationConfig

`Readonly`model

`Optional` `Beta`systemInstruction

`Optional` `Beta`toolConfig

`Optional` `Beta`tools