Skip to content

Commit 451c7b7

Browse files
committed
Add note about support to getLiveGenerativeModel docs
1 parent 79da676 commit 451c7b7

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs-devsite/ai.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The Firebase AI Web SDK.
2121
| <b>function(ai, ...)</b> |
2222
| [getGenerativeModel(ai, modelParams, requestOptions)](./ai.md#getgenerativemodel_80bd839) | Returns a [GenerativeModel](./ai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
2323
| [getImagenModel(ai, modelParams, requestOptions)](./ai.md#getimagenmodel_e1f6645) | <b><i>(Public Preview)</i></b> Returns an [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) class with methods for using Imagen.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported. |
24-
| [getLiveGenerativeModel(ai, modelParams)](./ai.md#getlivegenerativemodel_f2099ac) | <b><i>(Public Preview)</i></b> Returns a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) class for real-time, bidirectional communication. |
24+
| [getLiveGenerativeModel(ai, modelParams)](./ai.md#getlivegenerativemodel_f2099ac) | <b><i>(Public Preview)</i></b> Returns a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) class for real-time, bidirectional communication.<!-- -->The Live API is only supported in modern browser windows and Node &gt;<!-- -->= 22. |
2525

2626
## Classes
2727

@@ -284,6 +284,8 @@ If the `apiKey` or `projectId` fields are missing in your Firebase config.
284284
285285
Returns a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) class for real-time, bidirectional communication.
286286

287+
The Live API is only supported in modern browser windows and Node &gt;<!-- -->= 22.
288+
287289
<b>Signature:</b>
288290

289291
```typescript

packages/ai/src/api.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ export function getImagenModel(
145145
/**
146146
* Returns a {@link LiveGenerativeModel} class for real-time, bidirectional communication.
147147
*
148+
* The Live API is only supported in modern browser windows and Node >= 22.
149+
*
148150
* @param ai - An {@link AI} instance.
149151
* @param modelParams - Parameters to use when setting up a {@link LiveSession}.
150152
* @throws If the `apiKey` or `projectId` fields are missing in your

0 commit comments

Comments
 (0)