docs-devsite/ai.livegenerativemodel.md
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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()<!-- -->.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the LiveGenerativeModel class.
<b>Signature:</b>
export declare class LiveGenerativeModel extends AIModel
<b>Extends:</b> AIModel
| Property | Modifiers | Type | Description |
|---|---|---|---|
| generationConfig | LiveGenerationConfig | <b><i>(Public Preview)</i></b> | |
| systemInstruction | Content | <b><i>(Public Preview)</i></b> | |
| toolConfig | ToolConfig | <b><i>(Public Preview)</i></b> | |
| tools | Tool<!-- -->[] | <b><i>(Public Preview)</i></b> |
| Method | Modifiers | Description |
|---|---|---|
| connect() | <b><i>(Public Preview)</i></b> Starts a LiveSession<!-- -->. |
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
<b>Signature:</b>
generationConfig: LiveGenerationConfig;
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
<b>Signature:</b>
systemInstruction?: Content;
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
<b>Signature:</b>
toolConfig?: ToolConfig;
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
<b>Signature:</b>
tools?: Tool[];
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Starts a LiveSession<!-- -->.
<b>Signature:</b>
connect(): Promise<LiveSession>;
<b>Returns:</b>
Promise<LiveSession<!-- -->>
A LiveSession<!-- -->.
If the connection failed to be established with the server.