Update to match API changes

Author: dlarocque

common/api-review/vertexai.api.md

@@ -447,7 +447,9 @@ export interface ImagenGCSImage {
 
 // @public
 export interface ImagenGenerationConfig {
+    addWatermark?: boolean;
     aspectRatio?: ImagenAspectRatio;
+    imageFormat?: ImagenImageFormat;
     negativePrompt?: string;
     numberOfImages?: number;
 }
@@ -461,7 +463,7 @@ export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGC
 // @public
 export class ImagenImageFormat {
     compressionQuality?: number;
-    static jpeg(compressionQuality: number): ImagenImageFormat;
+    static jpeg(compressionQuality?: number): ImagenImageFormat;
     mimeType: string;
     static png(): ImagenImageFormat;
 }
@@ -475,23 +477,19 @@ export interface ImagenInlineImage {
 // @public
 export class ImagenModel extends VertexAIModel {
     constructor(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
-    generateImages(prompt: string, imagenRequestOptions?: ImagenGenerationConfig): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
-    generateImagesGCS(prompt: string, gcsURI: string, imagenRequestOptions?: ImagenGenerationConfig): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
-    readonly modelConfig: ImagenModelConfig;
+    generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+    readonly generationConfig?: ImagenGenerationConfig;
     // (undocumented)
     readonly requestOptions?: RequestOptions | undefined;
+    readonly safetySettings?: ImagenSafetySettings;
 }
 
 // @public
-export interface ImagenModelConfig {
-    addWatermark?: boolean;
-    imageFormat?: ImagenImageFormat;
-    safetySettings?: ImagenSafetySettings;
-}
-
-// @public
-export interface ImagenModelParams extends ImagenModelConfig {
+export interface ImagenModelParams {
+    generationConfig?: ImagenGenerationConfig;
     model: string;
+    safetySettings?: ImagenSafetySettings;
 }
 
 // @public

docs-devsite/_toc.yaml

@@ -540,8 +540,6 @@ toc:
     path: /docs/reference/js/vertexai.imageninlineimage.md
   - title: ImagenModel
     path: /docs/reference/js/vertexai.imagenmodel.md
-  - title: ImagenModelConfig
-    path: /docs/reference/js/vertexai.imagenmodelconfig.md
   - title: ImagenModelParams
     path: /docs/reference/js/vertexai.imagenmodelparams.md
   - title: ImagenSafetySettings

docs-devsite/vertexai.imagengenerationconfig.md

@@ -10,7 +10,9 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGenerationConfig interface
-Request-level configuration options for generating images with Imagen.
+Configuration options for generating images with Imagen.
+
+See the \[Google Cloud Docs\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#rest\_1).
 
 <b>Signature:</b>
 
@@ -22,23 +24,45 @@ export interface ImagenGenerationConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | The aspect ratio of the generated images. Defaults to <code>1:1</code>. |
-|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | A text prompt describing what should not be included in the image. |
-|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | The number of images to generate. Must be between 1 and 4. Defaults to 1. |
+|  [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | If true, adds a SynthID watermark to the generated images. |
+|  [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | The aspect ratio of the generated images. The default value is 1:1. used. |
+|  [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | The image format of the generated images. The default is PNG. |
+|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | A description of what should be omitted from the generated images. |
+|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | The number of images to generate. Must be between 1 and 4. The default value is 1. |
+
+## ImagenGenerationConfig.addWatermark
+
+If true, adds a SynthID watermark to the generated images.
+
+<b>Signature:</b>
+
+```typescript
+addWatermark?: boolean;
+```
 
 ## ImagenGenerationConfig.aspectRatio
 
-The aspect ratio of the generated images. Defaults to `1:1`<!-- -->.
+The aspect ratio of the generated images. The default value is 1:1. used.
 
 <b>Signature:</b>
 
 ```typescript
 aspectRatio?: ImagenAspectRatio;
 ```
 
+## ImagenGenerationConfig.imageFormat
+
+The image format of the generated images. The default is PNG.
+
+<b>Signature:</b>
+
+```typescript
+imageFormat?: ImagenImageFormat;
+```
+
 ## ImagenGenerationConfig.negativePrompt
 
-A text prompt describing what should not be included in the image.
+A description of what should be omitted from the generated images.
 
 <b>Signature:</b>
 
@@ -48,7 +72,7 @@ negativePrompt?: string;
 
 ## ImagenGenerationConfig.numberOfImages
 
-The number of images to generate. Must be between 1 and 4. Defaults to 1.
+The number of images to generate. Must be between 1 and 4. The default value is 1.
 
 <b>Signature:</b>
 

docs-devsite/vertexai.imagenimageformat.md

@@ -61,7 +61,7 @@ Creates an ImagenImageFormat for a JPEG image.
 <b>Signature:</b>
 
 ```typescript
-static jpeg(compressionQuality: number): ImagenImageFormat;
+static jpeg(compressionQuality?: number): ImagenImageFormat;
 ```
 
 #### Parameters

docs-devsite/vertexai.imagenmodel.md

@@ -31,15 +31,16 @@ export declare class ImagenModel extends VertexAIModel
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [modelConfig](./vertexai.imagenmodel.md#imagenmodelmodelconfig) |  | [ImagenModelConfig](./vertexai.imagenmodelconfig.md#imagenmodelconfig_interface) | Model-level configurations to use when using Imagen. |
+|  [generationConfig](./vertexai.imagenmodel.md#imagenmodelgenerationconfig) |  | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | The Imagen Generation Configuration. |
 |  [requestOptions](./vertexai.imagenmodel.md#imagenmodelrequestoptions) |  | [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) \| undefined |  |
+|  [safetySettings](./vertexai.imagenmodel.md#imagenmodelsafetysettings) |  | [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | Safety settings for filtering inappropriate content. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [generateImages(prompt, imagenRequestOptions)](./vertexai.imagenmodel.md#imagenmodelgenerateimages) |  | Generates images using the Imagen model and returns them as base64-encoded strings. |
-|  [generateImagesGCS(prompt, gcsURI, imagenRequestOptions)](./vertexai.imagenmodel.md#imagenmodelgenerateimagesgcs) |  | Generates images to Google Cloud Storage (GCS) using the Imagen model. |
+|  [generateImages(prompt)](./vertexai.imagenmodel.md#imagenmodelgenerateimages) |  | Generates images using the Imagen model and returns them as base64-encoded strings. |
+|  [generateImagesGCS(prompt, gcsURI)](./vertexai.imagenmodel.md#imagenmodelgenerateimagesgcs) |  | Generates images to Google Cloud Storage (GCS) using the Imagen model. |
 
 ## ImagenModel.(constructor)
 
@@ -63,14 +64,14 @@ constructor(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?:
 
 If the `apiKey` or `projectId` fields are missing in your Firebase config.
 
-## ImagenModel.modelConfig
+## ImagenModel.generationConfig
 
-Model-level configurations to use when using Imagen.
+The Imagen Generation Configuration.
 
 <b>Signature:</b>
 
 ```typescript
-readonly modelConfig: ImagenModelConfig;
+readonly generationConfig?: ImagenGenerationConfig;
 ```
 
 ## ImagenModel.requestOptions
@@ -81,24 +82,33 @@ readonly modelConfig: ImagenModelConfig;
 readonly requestOptions?: RequestOptions | undefined;
 ```
 
+## ImagenModel.safetySettings
+
+Safety settings for filtering inappropriate content.
+
+<b>Signature:</b>
+
+```typescript
+readonly safetySettings?: ImagenSafetySettings;
+```
+
 ## ImagenModel.generateImages()
 
 Generates images using the Imagen model and returns them as base64-encoded strings.
 
-If one or more images are filtered, the returned object will have a defined `filteredReason` property. If all images are filtered, the `images` array will be empty, and no error will be thrown.
+If the prompt was not blocked, but one or more of the generated images were filtered, the returned object will have a `filteredReason` property. If all images are filtered, the `images` array will be empty.
 
 <b>Signature:</b>
 
 ```typescript
-generateImages(prompt: string, imagenRequestOptions?: ImagenGenerationConfig): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
 ```
 
 #### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  prompt | string | The text prompt used to generate the images. |
-|  imagenRequestOptions | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | Configuration options for the Imagen generation request. See [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -114,12 +124,12 @@ If the request to generate images fails. This happens if the prompt is blocked.
 
 Generates images to Google Cloud Storage (GCS) using the Imagen model.
 
-If one or more images are filtered due to safety reasons, the returned object will have a defined `filteredReason` property. If all images are filtered, the `images` array will be empty, and no error will be thrown.
+If the prompt was not blocked, but one or more of the generated images were filtered, the returned object will have a `filteredReason` property. If all images are filtered, the `images` array will be empty.
 
 <b>Signature:</b>
 
 ```typescript
-generateImagesGCS(prompt: string, gcsURI: string, imagenRequestOptions?: ImagenGenerationConfig): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
 ```
 
 #### Parameters
@@ -128,7 +138,6 @@ generateImagesGCS(prompt: string, gcsURI: string, imagenRequestOptions?: ImagenG
 |  --- | --- | --- |
 |  prompt | string | The text prompt used to generate the images. |
 |  gcsURI | string | The GCS URI where the images should be stored. This should be a directory. For example, <code>gs://my-bucket/my-directory/</code>. |
-|  imagenRequestOptions | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | Configuration options for the Imagen generation request. See [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -144,12 +153,17 @@ If the request fails to generate images fails. This happens if the prompt is blo
 
 
 ```javascript
-const imagen = new ImagenModel(vertexAI, {
-  model: 'imagen-3.0-generate-001'
-});
+const imagen = new ImagenModel(
+  vertexAI,
+  {
+    model: 'imagen-3.0-generate-001'
+  }
+);
 
 const response = await imagen.generateImages('A photo of a cat');
-console.log(response.images[0].bytesBase64Encoded);
+if (response.images.length > 0) {
+  console.log(response.images[0].bytesBase64Encoded);
+}
 
 ```
 

docs-devsite/vertexai.imagenmodelconfig.md

@@ -15,15 +15,26 @@ Parameters for configuring an [ImagenModel](./vertexai.imagenmodel.md#imagenmode
 <b>Signature:</b>
 
 ```typescript
-export interface ImagenModelParams extends ImagenModelConfig 
+export interface ImagenModelParams 
 ```
-<b>Extends:</b> [ImagenModelConfig](./vertexai.imagenmodelconfig.md#imagenmodelconfig_interface)
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [generationConfig](./vertexai.imagenmodelparams.md#imagenmodelparamsgenerationconfig) | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | The Imagen Generation Configuration. |
 |  [model](./vertexai.imagenmodelparams.md#imagenmodelparamsmodel) | string | The Imagen model to use for generating images. For example: <code>imagen-3.0-generate-001</code>. |
+|  [safetySettings](./vertexai.imagenmodelparams.md#imagenmodelparamssafetysettings) | [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | Safety settings for filtering inappropriate content. |
+
+## ImagenModelParams.generationConfig
+
+The Imagen Generation Configuration.
+
+<b>Signature:</b>
+
+```typescript
+generationConfig?: ImagenGenerationConfig;
+```
 
 ## ImagenModelParams.model
 
@@ -34,3 +45,13 @@ The Imagen model to use for generating images. For example: `imagen-3.0-generate
 ```typescript
 model: string;
 ```
+
+## ImagenModelParams.safetySettings
+
+Safety settings for filtering inappropriate content.
+
+<b>Signature:</b>
+
+```typescript
+safetySettings?: ImagenSafetySettings;
+```

docs-devsite/vertexai.imagenmodelparams.md

@@ -54,7 +54,7 @@ The Vertex AI in Firebase Web SDK.
 |  [HarmSeverity](./vertexai.md#harmseverity) | Harm severity levels. |
 |  [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | Aspect ratios for Imagen images. |
 |  [ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel) | Person filter levels for Imagen. |
-|  [ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel) | Safety filter levels for Imagen. |
+|  [ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel) | Safety filter levels for Imagen |
 |  [SchemaType](./vertexai.md#schematype) | Contains the list of OpenAPI data types as defined by the [OpenAPI specification](https://swagger.io/docs/specification/data-models/data-types/) |
 |  [VertexAIErrorCode](./vertexai.md#vertexaierrorcode) | Standardized error codes that <code>[VertexAIError](./vertexai.vertexaierror.md#vertexaierror_class)</code> can have. |
 
@@ -91,10 +91,9 @@ The Vertex AI in Firebase Web SDK.
 |  [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 Google Cloud Storage (GCS). |
-|  [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | Request-level configuration options for generating images with Imagen. |
+|  [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | Configuration options for generating images with Imagen.<!-- -->See the \[Google Cloud Docs\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#rest\_1). |
 |  [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) | The response from a request to generate images with Imagen. |
 |  [ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface) | An image generated by Imagen, represented as inline bytes. |
-|  [ImagenModelConfig](./vertexai.imagenmodelconfig.md#imagenmodelconfig_interface) | Model-level configuration options for Imagen. |
 |  [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface) | Parameters for configuring an [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)<!-- -->. |
 |  [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | Safety settings for Imagen. |
 |  [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
@@ -439,7 +438,7 @@ export declare enum ImagenPersonFilterLevel
 
 ## ImagenSafetyFilterLevel
 
-Safety filter levels for Imagen.
+Safety filter levels for Imagen
 
 <b>Signature:</b>