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

Methods

connect normalizeModelName

Properties

_apiSettings generationConfig model systemInstruction? toolConfig? tools?

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

Methods

connect

connect(): Promise<LiveSession>
Beta
Starts a LiveSession.

Returns Promise<LiveSession>
A LiveSession.

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

`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 to use for generating images (for example, publishers/google/models/imagen-3.0-generate-002).

`Optional` `Beta`systemInstruction

systemInstruction?: Content

`Optional` `Beta`toolConfig

toolConfig?: ToolConfig

`Optional` `Beta`tools

tools?: Tool[]