review fixes

dlarocque · dlarocque · commit 50a1f5c08e4a · 2025-02-12T13:36:50.000-05:00
diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md
@@ -439,7 +439,7 @@ export enum ImagenAspectRatio {
     SQUARE = "1:1"
 }
 
-// @beta
+// @public
 export interface ImagenGCSImage {
     gcsURI: string;
     mimeType: string;
diff --git a/docs-devsite/vertexai.imagengcsimage.md b/docs-devsite/vertexai.imagengcsimage.md
@@ -10,11 +10,10 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGCSImage interface
-> 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.
-> 
-
 An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
 
+This feature is not available yet.
+
 <b>Signature:</b>
 
 ```typescript
@@ -25,15 +24,12 @@ export interface ImagenGCSImage
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | <b><i>(BETA)</i></b> The URI of the file in Cloud Storage (GCS) for Firestore. |
-|  [mimeType](./vertexai.imagengcsimage.md#imagengcsimagemimetype) | string | <b><i>(BETA)</i></b> The MIME type of the image; either <code>&quot;image/png&quot;</code> or <code>&quot;image/jpeg&quot;</code>.<!-- -->To request a different format, set the <code>imageFormat</code> property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>. |
+|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket. |
+|  [mimeType](./vertexai.imagengcsimage.md#imagengcsimagemimetype) | string | The MIME type of the image; either <code>&quot;image/png&quot;</code> or <code>&quot;image/jpeg&quot;</code>.<!-- -->To request a different format, set the <code>imageFormat</code> property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>. |
 
 ## ImagenGCSImage.gcsURI
 
-> 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.
-> 
-
-The URI of the file in Cloud Storage (GCS) for Firestore.
+The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.
 
 <b>Signature:</b>
 
@@ -47,9 +43,6 @@ gcsURI: string;
 
 ## ImagenGCSImage.mimeType
 
-> 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.
-> 
-
 The MIME type of the image; either `"image/png"` or `"image/jpeg"`<!-- -->.
 
 To request a different format, set the `imageFormat` property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>.
diff --git a/docs-devsite/vertexai.imagengenerationconfig.md b/docs-devsite/vertexai.imagengenerationconfig.md
@@ -15,7 +15,7 @@ https://github.com/firebase/firebase-js-sdk
 
 Configuration options for generating images with Imagen.
 
-See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) for more details.
+See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/vertexai.imagenimageformat.md b/docs-devsite/vertexai.imagenimageformat.md
@@ -13,7 +13,7 @@ https://github.com/firebase/firebase-js-sdk
 > 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.
 > 
 
-Defines the image format for images output by Imagen.
+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 <code>[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)</code>.
 
diff --git a/docs-devsite/vertexai.imagenmodel.md b/docs-devsite/vertexai.imagenmodel.md
@@ -34,7 +34,7 @@ export declare class ImagenModel extends VertexAIModel
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [generationConfig](./vertexai.imagenmodel.md#imagenmodelgenerationconfig) |  | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(BETA)</i></b> The Imagen Generation Configuration. |
+|  [generationConfig](./vertexai.imagenmodel.md#imagenmodelgenerationconfig) |  | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(BETA)</i></b> The Imagen generation configuration. |
 |  [requestOptions](./vertexai.imagenmodel.md#imagenmodelrequestoptions) |  | [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) \| undefined | <b><i>(BETA)</i></b> |
 |  [safetySettings](./vertexai.imagenmodel.md#imagenmodelsafetysettings) |  | [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | <b><i>(BETA)</i></b> Safety settings for filtering inappropriate content. |
 
@@ -62,7 +62,7 @@ constructor(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  vertexAI | [VertexAI](./vertexai.vertexai.md#vertexai_interface) | An instance of the Vertex AI in Firebase SDK. |
-|  modelParams | [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | Parameters to use when making Imagen requests. |
+|  modelParams | [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | Parameters to use when making requests to Imagen. |
 |  requestOptions | [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) \| undefined | Additional options to use when making requests. |
 
 #### Exceptions
@@ -74,7 +74,7 @@ If the `apiKey` or `projectId` fields are missing in your Firebase config.
 > 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.
 > 
 
-The Imagen Generation Configuration.
+The Imagen generation configuration.
 
 <b>Signature:</b>
 
@@ -133,7 +133,7 @@ generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineIma
 
 Promise&lt;[ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface)<!-- -->&lt;[ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface)<!-- -->&gt;&gt;
 
-A promise that resolves to an [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) object containing the generated images.
+A promise that resolves to an <code>[ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface)</code> object containing the generated images.
 
 #### Exceptions
 
diff --git a/docs-devsite/vertexai.imagenmodelparams.md b/docs-devsite/vertexai.imagenmodelparams.md
@@ -13,7 +13,7 @@ https://github.com/firebase/firebase-js-sdk
 > 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.
 > 
 
-Parameters for configuring an [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)<!-- -->.
+Parameters for configuring an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code>.
 
 <b>Signature:</b>
 
@@ -26,7 +26,7 @@ export interface ImagenModelParams
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [generationConfig](./vertexai.imagenmodelparams.md#imagenmodelparamsgenerationconfig) | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(BETA)</i></b> Configuration options for generating images with Imagen. |
-|  [model](./vertexai.imagenmodelparams.md#imagenmodelparamsmodel) | string | <b><i>(BETA)</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://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models. |
+|  [model](./vertexai.imagenmodelparams.md#imagenmodelparamsmodel) | string | <b><i>(BETA)</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. |
 |  [safetySettings](./vertexai.imagenmodelparams.md#imagenmodelparamssafetysettings) | [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | <b><i>(BETA)</i></b> Safety settings for filtering potentially inappropriate content. |
 
 ## ImagenModelParams.generationConfig
@@ -51,7 +51,7 @@ The Imagen model to use for generating images. For example: `imagen-3.0-generate
 
 Only Imagen 3 models (named `imagen-3.0-*`<!-- -->) are supported.
 
-See [model versions](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models.
+See [model versions](https://firebase.google.com/docs/vertex-ai/models) for a full list of supported Imagen 3 models.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/vertexai.imagensafetysettings.md b/docs-devsite/vertexai.imagensafetysettings.md
@@ -15,7 +15,7 @@ https://github.com/firebase/firebase-js-sdk
 
 Settings for controlling the aggressiveness of filtering out sensitive content.
 
-See the [https://www.newyorker.com/magazine/2018/12/10/the-friendship-that-made-google-huge](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details.
+See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details.
 
 <b>Signature:</b>
 
diff --git a/docs-devsite/vertexai.md b/docs-devsite/vertexai.md
@@ -30,7 +30,7 @@ The Vertex AI in Firebase Web SDK.
 |  [BooleanSchema](./vertexai.booleanschema.md#booleanschema_class) | Schema class for "boolean" types. |
 |  [ChatSession](./vertexai.chatsession.md#chatsession_class) | ChatSession class that enables sending chat messages and stores history of sent and received messages so far. |
 |  [GenerativeModel](./vertexai.generativemodel.md#generativemodel_class) | Class for generative model APIs. |
-|  [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | <b><i>(BETA)</i></b> Defines the image format for images output 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 <code>[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)</code>. |
+|  [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | <b><i>(BETA)</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 <code>[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)</code>. |
 |  [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class) | <b><i>(BETA)</i></b> Class for Imagen model APIs.<!-- -->This class provides methods for generating images using the Imagen model. |
 |  [IntegerSchema](./vertexai.integerschema.md#integerschema_class) | Schema class for "integer" types. |
 |  [NumberSchema](./vertexai.numberschema.md#numberschema_class) | Schema class for "number" types. |
@@ -90,12 +90,12 @@ The Vertex AI in Firebase Web SDK.
 |  [GenerativeContentBlob](./vertexai.generativecontentblob.md#generativecontentblob_interface) | Interface for sending an image. |
 |  [GroundingAttribution](./vertexai.groundingattribution.md#groundingattribution_interface) |  |
 |  [GroundingMetadata](./vertexai.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
-|  [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface) | <b><i>(BETA)</i></b> An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase. |
-|  [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(BETA)</i></b> Configuration options for generating images with Imagen.<!-- -->See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) for more details. |
+|  [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface) | An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.<!-- -->This feature is not available yet. |
+|  [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(BETA)</i></b> Configuration options for generating images with Imagen.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details. |
 |  [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) | <b><i>(BETA)</i></b> The response from a request to generate images with Imagen. |
 |  [ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface) | <b><i>(BETA)</i></b> An image generated by Imagen, represented as inline data. |
-|  [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | <b><i>(BETA)</i></b> Parameters for configuring an [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)<!-- -->. |
-|  [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | <b><i>(BETA)</i></b> Settings for controlling the aggressiveness of filtering out sensitive content.<!-- -->See the [https://www.newyorker.com/magazine/2018/12/10/the-friendship-that-made-google-huge](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details. |
+|  [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | <b><i>(BETA)</i></b> Parameters for configuring an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code>. |
+|  [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | <b><i>(BETA)</i></b> Settings for controlling the aggressiveness of filtering out sensitive content.<!-- -->See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details. |
 |  [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
 |  [ModelParams](./vertexai.modelparams.md#modelparams_interface) | Params passed to <code>[getGenerativeModel()](./vertexai.md#getgenerativemodel_e3037c9)</code>. |
 |  [ObjectSchemaInterface](./vertexai.objectschemainterface.md#objectschemainterface_interface) | Interface for <code>[ObjectSchema](./vertexai.objectschema.md#objectschema_class)</code> class. |
diff --git a/docs-devsite/vertexai.vertexaimodel.md b/docs-devsite/vertexai.vertexaimodel.md
@@ -24,7 +24,7 @@ export declare abstract class VertexAIModel
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [model](./vertexai.vertexaimodel.md#vertexaimodelmodel) |  | string | The fully qualified model resource name to use for generating images (e.g. <code>publishers/google/models/imagen-3.0-generate-002</code>). |
+|  [model](./vertexai.vertexaimodel.md#vertexaimodelmodel) |  | string | The fully qualified model resource name to use for generating images (for example, <code>publishers/google/models/imagen-3.0-generate-002</code>). |
 
 ## Methods
 
@@ -34,7 +34,7 @@ export declare abstract class VertexAIModel
 
 ## VertexAIModel.model
 
-The fully qualified model resource name to use for generating images (e.g. `publishers/google/models/imagen-3.0-generate-002`<!-- -->).
+The fully qualified model resource name to use for generating images (for example, `publishers/google/models/imagen-3.0-generate-002`<!-- -->).
 
 <b>Signature:</b>
 
diff --git a/packages/vertexai/src/models/imagen-model.ts b/packages/vertexai/src/models/imagen-model.ts
@@ -54,7 +54,7 @@ import { VertexAIModel } from './vertexai-model';
  */
 export class ImagenModel extends VertexAIModel {
   /**
-   * The Imagen Generation Configuration.
+   * The Imagen generation configuration.
    */
   generationConfig?: ImagenGenerationConfig;
   /**
@@ -66,7 +66,7 @@ export class ImagenModel extends VertexAIModel {
    * Constructs a new instance of the <code>{@link ImagenModel}</code> class.
    *
    * @param vertexAI - An instance of the Vertex AI in Firebase SDK.
-   * @param modelParams - Parameters to use when making Imagen requests.
+   * @param modelParams - Parameters to use when making requests to Imagen.
    * @param requestOptions - Additional options to use when making requests.
    *
    * @throws If the `apiKey` or `projectId` fields are missing in your
@@ -93,7 +93,7 @@ export class ImagenModel extends VertexAIModel {
    * backwards-incompatible ways.
    *
    * @param prompt - A text prompt describing the image(s) to generate.
-   * @returns A promise that resolves to an {@link ImagenGenerationResponse}
+   * @returns A promise that resolves to an <code>{@link ImagenGenerationResponse}</code>
    * object containing the generated images.
    *
    * @throws If the request to generate images fails. This happens if the
diff --git a/packages/vertexai/src/models/vertexai-model.ts b/packages/vertexai/src/models/vertexai-model.ts
@@ -29,7 +29,7 @@ import { _isFirebaseServerApp } from '@firebase/app';
 export abstract class VertexAIModel {
   /**
    * The fully qualified model resource name to use for generating images
-   * (e.g. `publishers/google/models/imagen-3.0-generate-002`).
+   * (for example, `publishers/google/models/imagen-3.0-generate-002`).
    */
   readonly model: string;
 
diff --git a/packages/vertexai/src/requests/imagen-image-format.ts b/packages/vertexai/src/requests/imagen-image-format.ts
@@ -18,7 +18,7 @@
 import { logger } from '../logger';
 
 /**
- * Defines the image format for images output by Imagen.
+ * 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
diff --git a/packages/vertexai/src/types/imagen/requests.ts b/packages/vertexai/src/types/imagen/requests.ts
@@ -18,7 +18,7 @@
 import { ImagenImageFormat } from '../../requests/imagen-image-format';
 
 /**
- * Parameters for configuring an {@link ImagenModel}.
+ * Parameters for configuring an <code>{@link ImagenModel}</code>.
  *
  * @beta
  */
@@ -29,7 +29,7 @@ export interface ImagenModelParams {
    *
    * Only Imagen 3 models (named `imagen-3.0-*`) are supported.
    *
-   * See {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning | model versions}
+   * See {@link https://firebase.google.com/docs/vertex-ai/models | model versions}
    * for a full list of supported Imagen 3 models.
    */
   model: string;
@@ -46,7 +46,8 @@ export interface ImagenModelParams {
 /**
  * Configuration options for generating images with Imagen.
  *
- * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images | Cloud documentation} for more details.
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation} for 
+ * more details.
  *
  * @beta
  */
@@ -159,7 +160,7 @@ export enum ImagenPersonFilterLevel {
 /**
  * Settings for controlling the aggressiveness of filtering out sensitive content.
  *
- * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters | https://www.newyorker.com/magazine/2018/12/10/the-friendship-that-made-google-huge}
+ * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters | Cloud documentation }
  * for more details.
  *
  * @beta
diff --git a/packages/vertexai/src/types/imagen/responses.ts b/packages/vertexai/src/types/imagen/responses.ts
@@ -36,7 +36,7 @@ export interface ImagenInlineImage {
 /**
  * An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
  *
- * @beta
+ * This feature is not available yet.
  */
 export interface ImagenGCSImage {
   /**
@@ -46,7 +46,7 @@ export interface ImagenGCSImage {
    */
   mimeType: string;
   /**
-   * The URI of the file in Cloud Storage (GCS) for Firestore.
+   * The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.
    *
    * @example `"gs://bucket-name/path/sample_0.jpg"`.
    */

Original file line number	Diff line number	Diff line change
`@@ -439,7 +439,7 @@ export enum ImagenAspectRatio {`
`439`	`439`	`SQUARE = "1:1"`
`440`	`440`	`}`
`441`	`441`
`442`		`-// @beta`
	`442`	`+// @public`
`443`	`443`	`export interface ImagenGCSImage {`
`444`	`444`	`gcsURI: string;`
`445`	`445`	`mimeType: string;`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ https://github.com/firebase/firebase-js-sdk`
`13`	`13`	`> 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.`
`14`	`14`	`>`
`15`	`15`
`16`		`-Defines the image format for images output by Imagen.`
	`16`	`+Defines the image format for images generated by Imagen.`
`17`	`17`
`18`	`18`	`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 <code>[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)</code>.`
`19`	`19`