review fixes

firebase · Feb 19, 2025 · 60bcae9 · 60bcae9
1 parent 44ab79d
commit 60bcae9
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 21 deletions.
diff --git a/docs-devsite/vertexai.imagengcsimage.md b/docs-devsite/vertexai.imagengcsimage.md
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGCSImage interface
-An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
+An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
 
 This feature is not available yet.
 
@@ -24,12 +24,12 @@ export interface ImagenGCSImage
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket. |
+|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage for Firebase 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
 
-The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.
+The URI of the file stored in a Cloud Storage for Firebase bucket.
 
 <b>Signature:</b>
 

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 [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
+See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images-imagen) for more details.
 
 <b>Signature:</b>
 
@@ -27,11 +27,11 @@ export interface ImagenGenerationConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->The default value depends on the Imagen model; see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>addWatermark</code></a> documentation for more details. |
+|  [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->For Imagen 3 models, the default value is <code>true</code>; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>addWatermark</code></a> documentation for more details. |
 |  [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> The aspect ratio of the generated images. The default value is square 1:1. Supported aspect ratios depend on the Imagen model, see <code>[ImagenAspectRatio](./vertexai.md#imagenaspectratio)</code> for more details. |
 |  [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | <b><i>(Public Preview)</i></b> The image format of the generated images. The default is PNG.<!-- -->See <code>[ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)</code> for more details. |
-|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | <b><i>(Public Preview)</i></b> A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details. |
-|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | <b><i>(Public Preview)</i></b> The number of images to generate. The default value is 1.<!-- -->The number of sample images that may be generated in each request depends on the model (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>sampleCount</code></a> documentation for more details. |
+|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | <b><i>(Public Preview)</i></b> A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details. |
+|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | <b><i>(Public Preview)</i></b> The number of images to generate. The default value is 1.<!-- -->The number of sample images that may be generated in each request depends on the model (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>sampleCount</code></a> documentation for more details. |
 
 ## ImagenGenerationConfig.addWatermark
 
@@ -42,7 +42,7 @@ Whether to add an invisible watermark to generated images.
 
 If set to `true`<!-- -->, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to `false`<!-- -->, watermarking will be disabled.
 
-The default value depends on the Imagen model; see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>addWatermark</code></a> documentation for more details.
+For Imagen 3 models, the default value is `true`<!-- -->; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>addWatermark</code></a> documentation for more details.
 
 <b>Signature:</b>
 
@@ -87,7 +87,7 @@ A description of what should be omitted from the generated images.
 
 Support for negative prompts depends on the Imagen model.
 
-See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
+See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details.
 
 <b>Signature:</b>
 
@@ -102,7 +102,7 @@ negativePrompt?: string;
 
 The number of images to generate. The default value is 1.
 
-The number of sample images that may be generated in each request depends on the model (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>sampleCount</code></a> documentation for more details.
+The number of sample images that may be generated in each request depends on the model (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>sampleCount</code></a> documentation for more details.
 
 <b>Signature:</b>
 

diff --git a/docs-devsite/vertexai.md b/docs-devsite/vertexai.md
@@ -90,8 +90,8 @@ 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) | 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>(Public Preview)</i></b> Configuration options for generating images with Imagen.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details. |
+|  [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface) | An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.<!-- -->This feature is not available yet. |
+|  [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(Public Preview)</i></b> Configuration options for generating images with Imagen.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images-imagen) for more details. |
 |  [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) | <b><i>(Public Preview)</i></b> The response from a request to generate images with Imagen. |
 |  [ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface) | <b><i>(Public Preview)</i></b> An image generated by Imagen, represented as inline data. |
 |  [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | <b><i>(Public Preview)</i></b> Parameters for configuring an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code>. |

diff --git a/packages/vertexai/src/models/imagen-model.ts b/packages/vertexai/src/models/imagen-model.ts
@@ -120,12 +120,12 @@ export class ImagenModel extends VertexAIModel {
   }
 
   /**
-   * Generates images to Cloud Storage (GCS) for Firebase using the Imagen model.
+   * Generates images to Cloud Storage for Firebase using the Imagen model.
    *
    * @internal This method is temporarily internal.
    *
    * @param prompt - A text prompt describing the image(s) to generate.
-   * @param gcsURI - The URI of file stored in a Cloud Storage (GCS) for Firebase bucket.
+   * @param gcsURI - The URI of file stored in a Cloud Storage for Firebase bucket.
    * This should be a directory. For example, `gs://my-bucket/my-directory/`.
    * @returns A promise that resolves to an <code>{@link ImagenGenerationResponse}</code>
    * object containing the URLs of the generated images.

diff --git a/packages/vertexai/src/types/imagen/internal.ts b/packages/vertexai/src/types/imagen/internal.ts
@@ -121,7 +121,7 @@ export interface PredictRequestBody {
  */
 export type ImagenGenerationParams = {
   /**
-   * The Cloud Storage (GCS) for Firebase URI where the images should be stored
+   * The Cloud Storage for Firebase bucket URI where the images should be stored
    * (for GCS requests only).
    */
   gcsURI?: string;

diff --git a/packages/vertexai/src/types/imagen/requests.ts b/packages/vertexai/src/types/imagen/requests.ts
@@ -46,7 +46,7 @@ export interface ImagenModelParams {
 /**
  * Configuration options for generating images with Imagen.
  *
- * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation} for
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
  * more details.
  *
  * @beta
@@ -57,14 +57,14 @@ export interface ImagenGenerationConfig {
    *
    * Support for negative prompts depends on the Imagen model.
    *
-   * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation} for more details.
+   * See the {@link http://firebase.google.com/docs/vertex-ai/model-parameters#imagen | documentation} for more details.
    */
   negativePrompt?: string;
   /**
    * The number of images to generate. The default value is 1.
    *
    * The number of sample images that may be generated in each request depends on the model
-   * (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>sampleCount</code></a>
+   * (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>sampleCount</code></a>
    * documentation for more details.
    */
   numberOfImages?: number;
@@ -86,7 +86,7 @@ export interface ImagenGenerationConfig {
    * If set to `true`, an invisible SynthID watermark is embedded in generated images to indicate
    * that they are AI generated. If set to `false`, watermarking will be disabled.
    *
-   * The default value depends on the Imagen model; see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>addWatermark</code></a>
+   * For Imagen 3 models, the default value is `true`; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>addWatermark</code></a>
    * documentation for more details.
    */
   addWatermark?: boolean;

diff --git a/packages/vertexai/src/types/imagen/responses.ts b/packages/vertexai/src/types/imagen/responses.ts
@@ -34,7 +34,7 @@ export interface ImagenInlineImage {
 }
 
 /**
- * An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
+ * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
  *
  * This feature is not available yet.
  */
@@ -46,7 +46,7 @@ export interface ImagenGCSImage {
    */
   mimeType: string;
   /**
-   * The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.
+   * The URI of the file stored in a Cloud Storage for Firebase bucket.
    *
    * @example `"gs://bucket-name/path/sample_0.jpg"`.
    */