Skip to content

Commit f2df40c

Browse files
committed
docs(ai): Remove references to specific model versions
1 parent cc605e7 commit f2df40c

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

docs-devsite/ai.aimodel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ export declare abstract class AIModel
2626

2727
| Property | Modifiers | Type | Description |
2828
| --- | --- | --- | --- |
29-
| [model](./ai.aimodel.md#aimodelmodel) | | string | The fully qualified model resource name to use for generating images (for example, <code>publishers/google/models/imagen-3.0-generate-002</code>). |
29+
| [model](./ai.aimodel.md#aimodelmodel) | | string | The fully qualified model resource name to use for generating images (for example, <code>publishers/google/models/model-name</code>). |
3030

3131
## AIModel.model
3232

33-
The fully qualified model resource name to use for generating images (for example, `publishers/google/models/imagen-3.0-generate-002`<!-- -->).
33+
The fully qualified model resource name to use for generating images (for example, `publishers/google/models/model-name`<!-- -->).
3434

3535
<b>Signature:</b>
3636

docs-devsite/ai.imagenmodel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ https://github.com/firebase/firebase-js-sdk
1515
1616
Class for Imagen model APIs.
1717

18-
This class provides methods for generating images using the Imagen model.
18+
This class provides methods for generating images using the Imagen model. See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->.
1919

2020
<b>Signature:</b>
2121

@@ -144,7 +144,7 @@ If the request to generate images fails. This happens if the prompt is blocked.
144144
const imagen = new ImagenModel(
145145
ai,
146146
{
147-
model: 'imagen-3.0-generate-002'
147+
model: 'imagen-model-name'
148148
}
149149
);
150150

docs-devsite/ai.imagenmodelparams.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface ImagenModelParams
2626
| Property | Type | Description |
2727
| --- | --- | --- |
2828
| [generationConfig](./ai.imagenmodelparams.md#imagenmodelparamsgenerationconfig) | [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(Public Preview)</i></b> Configuration options for generating images with Imagen. |
29-
| [model](./ai.imagenmodelparams.md#imagenmodelparamsmodel) | string | <b><i>(Public Preview)</i></b> The Imagen model to use for generating images. For example: <code>imagen-3.0-generate-002</code>.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported.<!-- -->See [model versions](https://firebase.google.com/docs/vertex-ai/models) for a full list of supported Imagen 3 models. |
29+
| [model](./ai.imagenmodelparams.md#imagenmodelparamsmodel) | string | <b><i>(Public Preview)</i></b> The Imagen model to use for generating images.<!-- -->See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->.<!-- -->See [model versions](https://firebase.google.com/docs/vertex-ai/models) for a full list of supported Imagen 3 models. |
3030
| [safetySettings](./ai.imagenmodelparams.md#imagenmodelparamssafetysettings) | [ImagenSafetySettings](./ai.imagensafetysettings.md#imagensafetysettings_interface) | <b><i>(Public Preview)</i></b> Safety settings for filtering potentially inappropriate content. |
3131

3232
## ImagenModelParams.generationConfig
@@ -47,9 +47,9 @@ generationConfig?: ImagenGenerationConfig;
4747
> 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.
4848
>
4949

50-
The Imagen model to use for generating images. For example: `imagen-3.0-generate-002`<!-- -->.
50+
The Imagen model to use for generating images.
5151

52-
Only Imagen 3 models (named `imagen-3.0-*`<!-- -->) are supported.
52+
See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->.
5353

5454
See [model versions](https://firebase.google.com/docs/vertex-ai/models) for a full list of supported Imagen 3 models.
5555

docs-devsite/ai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The Firebase AI Web SDK.
2020
| [getAI(app, options)](./ai.md#getai_a94a413) | Returns the default [AI](./ai.ai.md#ai_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
2121
| <b>function(ai, ...)</b> |
2222
| [getGenerativeModel(ai, modelParams, requestOptions)](./ai.md#getgenerativemodel_c63f46a) | Returns a [GenerativeModel](./ai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
23-
| [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. |
23+
| [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.<!-- -->See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->. |
2424

2525
## Classes
2626

@@ -36,7 +36,7 @@ The Firebase AI Web SDK.
3636
| [GenerativeModel](./ai.generativemodel.md#generativemodel_class) | Class for generative model APIs. |
3737
| [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) | Configuration class for the Gemini Developer API.<!-- -->Use this with [AIOptions](./ai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./ai.md#getai_a94a413) to specify the Gemini Developer API as the backend. |
3838
| [ImagenImageFormat](./ai.imagenimageformat.md#imagenimageformat_class) | <b><i>(Public Preview)</i></b> Defines the image format for images generated by Imagen.<!-- -->Use this class to specify the desired format (JPEG or PNG) and compression quality for images generated by Imagen. This is typically included as part of [ImagenModelParams](./ai.imagenmodelparams.md#imagenmodelparams_interface)<!-- -->. |
39-
| [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) | <b><i>(Public Preview)</i></b> Class for Imagen model APIs.<!-- -->This class provides methods for generating images using the Imagen model. |
39+
| [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) | <b><i>(Public Preview)</i></b> Class for Imagen model APIs.<!-- -->This class provides methods for generating images using the Imagen model. See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->. |
4040
| [IntegerSchema](./ai.integerschema.md#integerschema_class) | Schema class for "integer" types. |
4141
| [NumberSchema](./ai.numberschema.md#numberschema_class) | Schema class for "number" types. |
4242
| [ObjectSchema](./ai.objectschema.md#objectschema_class) | Schema class for "object" types. The <code>properties</code> param must be a map of <code>Schema</code> objects. |
@@ -254,7 +254,7 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams | Hy
254254
255255
Returns an [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) class with methods for using Imagen.
256256

257-
Only Imagen 3 models (named `imagen-3.0-*`<!-- -->) are supported.
257+
See the documentation for a list of [supported models](https://firebase.google.com/docs/ai-logic/models)<!-- -->.
258258

259259
<b>Signature:</b>
260260

packages/ai/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export function getGenerativeModel(
132132
/**
133133
* Returns an {@link ImagenModel} class with methods for using Imagen.
134134
*
135-
* Only Imagen 3 models (named `imagen-3.0-*`) are supported.
135+
* See the documentation for a list of {@link https://firebase.google.com/docs/ai-logic/models | supported models}.
136136
*
137137
* @param ai - An {@link AI} instance.
138138
* @param modelParams - Parameters to use when making Imagen requests.

packages/ai/src/models/ai-model.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { _isFirebaseServerApp } from '@firebase/app';
3232
export abstract class AIModel {
3333
/**
3434
* The fully qualified model resource name to use for generating images
35-
* (for example, `publishers/google/models/imagen-3.0-generate-002`).
35+
* (for example, `publishers/google/models/model-name`).
3636
*/
3737
readonly model: string;
3838

packages/ai/src/models/imagen-model.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,14 @@ import { AIModel } from './ai-model';
3434
* Class for Imagen model APIs.
3535
*
3636
* This class provides methods for generating images using the Imagen model.
37+
* See the documentation for a list of {@link https://firebase.google.com/docs/ai-logic/models | supported models}.
3738
*
3839
* @example
3940
* ```javascript
4041
* const imagen = new ImagenModel(
4142
* ai,
4243
* {
43-
* model: 'imagen-3.0-generate-002'
44+
* model: 'imagen-model-name'
4445
* }
4546
* );
4647
*

packages/ai/src/types/imagen/requests.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ import { ImagenImageFormat } from '../../requests/imagen-image-format';
2525
export interface ImagenModelParams {
2626
/**
2727
* The Imagen model to use for generating images.
28-
* For example: `imagen-3.0-generate-002`.
2928
*
30-
* Only Imagen 3 models (named `imagen-3.0-*`) are supported.
29+
* See the documentation for a list of {@link https://firebase.google.com/docs/ai-logic/models | supported models}.
3130
*
3231
* See {@link https://firebase.google.com/docs/vertex-ai/models | model versions}
3332
* for a full list of supported Imagen 3 models.

0 commit comments

Comments
 (0)