Skip to content

Commit 60bcae9

Browse files
committed
review fixes
1 parent 44ab79d commit 60bcae9

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

docs-devsite/vertexai.imagengcsimage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# ImagenGCSImage interface
13-
An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
13+
An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
1414

1515
This feature is not available yet.
1616

@@ -24,12 +24,12 @@ export interface ImagenGCSImage
2424

2525
| Property | Type | Description |
2626
| --- | --- | --- |
27-
| [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket. |
27+
| [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage for Firebase bucket. |
2828
| [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>. |
2929

3030
## ImagenGCSImage.gcsURI
3131

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

3434
<b>Signature:</b>
3535

docs-devsite/vertexai.imagengenerationconfig.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ https://github.com/firebase/firebase-js-sdk
1515
1616
Configuration options for generating images with Imagen.
1717

18-
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
18+
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images-imagen) for more details.
1919

2020
<b>Signature:</b>
2121

@@ -27,11 +27,11 @@ export interface ImagenGenerationConfig
2727

2828
| Property | Type | Description |
2929
| --- | --- | --- |
30-
| [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. |
30+
| [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. |
3131
| [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. |
3232
| [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. |
33-
| [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. |
34-
| [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. |
33+
| [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. |
34+
| [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. |
3535

3636
## ImagenGenerationConfig.addWatermark
3737

@@ -42,7 +42,7 @@ Whether to add an invisible watermark to generated images.
4242

4343
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.
4444

45-
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.
45+
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.
4646

4747
<b>Signature:</b>
4848

@@ -87,7 +87,7 @@ A description of what should be omitted from the generated images.
8787

8888
Support for negative prompts depends on the Imagen model.
8989

90-
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
90+
See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details.
9191

9292
<b>Signature:</b>
9393

@@ -102,7 +102,7 @@ negativePrompt?: string;
102102

103103
The number of images to generate. The default value is 1.
104104

105-
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.
105+
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.
106106

107107
<b>Signature:</b>
108108

docs-devsite/vertexai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ The Vertex AI in Firebase Web SDK.
9090
| [GenerativeContentBlob](./vertexai.generativecontentblob.md#generativecontentblob_interface) | Interface for sending an image. |
9191
| [GroundingAttribution](./vertexai.groundingattribution.md#groundingattribution_interface) | |
9292
| [GroundingMetadata](./vertexai.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
93-
| [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface) | An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.<!-- -->This feature is not available yet. |
94-
| [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. |
93+
| [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. |
94+
| [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. |
9595
| [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) | <b><i>(Public Preview)</i></b> The response from a request to generate images with Imagen. |
9696
| [ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface) | <b><i>(Public Preview)</i></b> An image generated by Imagen, represented as inline data. |
9797
| [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | <b><i>(Public Preview)</i></b> Parameters for configuring an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code>. |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,12 @@ export class ImagenModel extends VertexAIModel {
120120
}
121121

122122
/**
123-
* Generates images to Cloud Storage (GCS) for Firebase using the Imagen model.
123+
* Generates images to Cloud Storage for Firebase using the Imagen model.
124124
*
125125
* @internal This method is temporarily internal.
126126
*
127127
* @param prompt - A text prompt describing the image(s) to generate.
128-
* @param gcsURI - The URI of file stored in a Cloud Storage (GCS) for Firebase bucket.
128+
* @param gcsURI - The URI of file stored in a Cloud Storage for Firebase bucket.
129129
* This should be a directory. For example, `gs://my-bucket/my-directory/`.
130130
* @returns A promise that resolves to an <code>{@link ImagenGenerationResponse}</code>
131131
* object containing the URLs of the generated images.

packages/vertexai/src/types/imagen/internal.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export interface PredictRequestBody {
121121
*/
122122
export type ImagenGenerationParams = {
123123
/**
124-
* The Cloud Storage (GCS) for Firebase URI where the images should be stored
124+
* The Cloud Storage for Firebase bucket URI where the images should be stored
125125
* (for GCS requests only).
126126
*/
127127
gcsURI?: string;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ImagenModelParams {
4646
/**
4747
* Configuration options for generating images with Imagen.
4848
*
49-
* See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation} for
49+
* See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
5050
* more details.
5151
*
5252
* @beta
@@ -57,14 +57,14 @@ export interface ImagenGenerationConfig {
5757
*
5858
* Support for negative prompts depends on the Imagen model.
5959
*
60-
* See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation} for more details.
60+
* See the {@link http://firebase.google.com/docs/vertex-ai/model-parameters#imagen | documentation} for more details.
6161
*/
6262
negativePrompt?: string;
6363
/**
6464
* The number of images to generate. The default value is 1.
6565
*
6666
* The number of sample images that may be generated in each request depends on the model
67-
* (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>sampleCount</code></a>
67+
* (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen"><code>sampleCount</code></a>
6868
* documentation for more details.
6969
*/
7070
numberOfImages?: number;
@@ -86,7 +86,7 @@ export interface ImagenGenerationConfig {
8686
* If set to `true`, an invisible SynthID watermark is embedded in generated images to indicate
8787
* that they are AI generated. If set to `false`, watermarking will be disabled.
8888
*
89-
* 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>
89+
* 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>
9090
* documentation for more details.
9191
*/
9292
addWatermark?: boolean;

packages/vertexai/src/types/imagen/responses.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface ImagenInlineImage {
3434
}
3535

3636
/**
37-
* An image generated by Imagen, stored in Cloud Storage (GCS) for Firebase.
37+
* An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
3838
*
3939
* This feature is not available yet.
4040
*/
@@ -46,7 +46,7 @@ export interface ImagenGCSImage {
4646
*/
4747
mimeType: string;
4848
/**
49-
* The URI of the file stored in a Cloud Storage (GCS) for Firestore bucket.
49+
* The URI of the file stored in a Cloud Storage for Firebase bucket.
5050
*
5151
* @example `"gs://bucket-name/path/sample_0.jpg"`.
5252
*/

0 commit comments

Comments
 (0)