Imagen Documentation by dlarocque · Pull Request #8776 · firebase/firebase-js-sdk

dlarocque · 2025-02-07T17:39:38Z

Imagen public documentation pulled out from code, for easier TW review.

Imagen PR: #8683

changeset-bot · 2025-02-07T17:39:42Z

⚠️ No Changeset found

Latest commit: 60bcae9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

google-oss-bot · 2025-02-07T17:49:10Z

Size Report ¹

Affected Products

No changes between base commit (0e9ff0a) and merge commit (f1df0c9).

Test Logs

Base (0e9ff0a): https://github.com/firebase/firebase-js-sdk/actions/runs/13314855954
Merge (f1df0c9): https://github.com/firebase/firebase-js-sdk/actions/runs/13422747722

https://storage.googleapis.com/firebase-sdk-metric-reports/FxaCcxAjiS.html

google-oss-bot · 2025-02-07T18:00:22Z

Size Analysis Report ¹

Affected Products

No changes between base commit (0e9ff0a) and merge commit (f1df0c9).

Test Logs

Base (0e9ff0a): https://github.com/firebase/firebase-js-sdk/actions/runs/13314855954
Merge (f1df0c9): https://github.com/firebase/firebase-js-sdk/actions/runs/13422747722

https://storage.googleapis.com/firebase-sdk-metric-reports/Qc1UegB5GA.html

docs-devsite/vertexai.imagengcsimage.md

docs-devsite/vertexai.imagengenerationconfig.md

docs-devsite/vertexai.imagenimageformat.md

docs-devsite/vertexai.imagenmodel.md

docs-devsite/vertexai.imagenmodelparams.md

docs-devsite/vertexai.imagensafetysettings.md

docs-devsite/vertexai.vertexaimodel.md

This reverts commit f095563.

rachelsaunders · 2025-02-19T19:37:02Z

docs-devsite/vertexai.imagengcsimage.md

 {% endcomment %}

 # ImagenGCSImage interface
+An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.


Suggested change

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.

rachelsaunders · 2025-02-19T19:37:28Z

docs-devsite/vertexai.imagengcsimage.md

 |  --- | --- | --- |
-|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string |  |
-|  [mimeType](./vertexai.imagengcsimage.md#imagengcsimagemimetype) | string |  |
+|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket. |


rachelsaunders · 2025-02-19T19:38:05Z

docs-devsite/vertexai.imagengcsimage.md


 ## ImagenGCSImage.gcsURI

+The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.


Suggested change

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.

rachelsaunders · 2025-02-19T19:38:49Z

docs-devsite/vertexai.imagengenerationconfig.md

+
+Configuration options for generating images with Imagen.
+
+See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.


Suggested change

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.

rachelsaunders · 2025-02-19T19:40:37Z

docs-devsite/vertexai.imagengenerationconfig.md

-|  [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) |  |
-|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string |  |
-|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number |  |
+|  [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. |


Suggested change

| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | (Public Preview) 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 | (Public Preview) 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. |

rachelsaunders · 2025-02-19T19:41:31Z

docs-devsite/vertexai.imagengenerationconfig.md

+|  [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. |
+|  [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. |


Suggested change

| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | (Public Preview) 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. |

| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | (Public Preview) 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. |

rachelsaunders · 2025-02-19T19:42:18Z

docs-devsite/vertexai.imagengenerationconfig.md

+|  [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. |


Suggested change

| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | (Public Preview) 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. |

| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | (Public Preview) 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. |

* WIP * Introduce VertexAIModel base class, add documentation, and respond to other comments * Generate devsite docs * revert dataconnect change * formatting * WIP * Introduce VertexAIModel base class, add documentation, and respond to other comments * Generate devsite docs * revert dataconnect change * formatting * Fix ImagenRequestConfig comment * Improve tests * Formatting * Add ImagenGenerationResponse * Formatting * Update to match API changes * fixes * format * Update API reports * add changeset * update * format * Update API reports * remove public docs * Nest imageFormat in outputOptions * remove unecessary console.log * Log warning if compressionQuality outside of range * format * Imagen Documentation (#8776) * Revert "remove public docs" This reverts commit f095563. * update docs * update docs * format * minor fixes * format * mark all APIs beta instead of public * review fixes * format * Replace (BETA) with (Public Preview) in docs * fix links * another pass * format * review fixes * Cleanup * update changeset --------- Co-authored-by: dlarocque <dlarocque@users.noreply.github.com>

dlarocque requested review from a team as code owners February 7, 2025 17:39

dlarocque marked this pull request as draft February 7, 2025 17:40

dlarocque marked this pull request as ready for review February 7, 2025 21:02

dlarocque requested a review from rachelsaunders February 7, 2025 21:02