Generate devsite docs

Author: dlarocque

common/api-review/vertexai.api.md

@@ -432,15 +432,10 @@ export enum HarmSeverity {
 
 // @public
 export enum ImagenAspectRatio {
-    // (undocumented)
     LANDSCAPE_16x9 = "16:9",
-    // (undocumented)
     LANDSCAPE_3x4 = "3:4",
-    // (undocumented)
     PORTRAIT_4x3 = "4:3",
-    // (undocumented)
     PORTRAIT_9x16 = "9:16",
-    // (undocumented)
     SQUARE = "1:1"
 }
 
@@ -465,10 +460,8 @@ export interface ImagenGenerationConfig {
 
 // @public
 export class ImagenImageFormat {
-    // (undocumented)
     compressionQuality?: number;
     static jpeg(compressionQuality: number): ImagenImageFormat;
-    // (undocumented)
     mimeType: string;
     static png(): ImagenImageFormat;
 }
@@ -821,7 +814,7 @@ export const enum VertexAIErrorCode {
 export class VertexAIModel {
     // @internal
     protected constructor(vertexAI: VertexAI, modelName: string);
-    // (undocumented)
+    // @internal (undocumented)
     protected _apiSettings: ApiSettings;
     readonly model: string;
     static normalizeModelName(modelName: string): string;

docs-devsite/_toc.yaml

@@ -536,8 +536,6 @@ toc:
         path: /docs/reference/js/vertexai.imagengenerationconfig.md
       - title: ImagenImageFormat
         path: /docs/reference/js/vertexai.imagenimageformat.md
-      - title: ImagenImageReponse
-        path: /docs/reference/js/vertexai.imagenimagereponse.md
       - title: ImagenInlineImage
         path: /docs/reference/js/vertexai.imageninlineimage.md
       - title: ImagenInlineImageResponse
@@ -568,8 +566,6 @@ toc:
         path: /docs/reference/js/vertexai.requestoptions.md
       - title: RetrievedContextAttribution
         path: /docs/reference/js/vertexai.retrievedcontextattribution.md
-      - title: SafetyAttributes
-        path: /docs/reference/js/vertexai.safetyattributes.md
       - title: SafetyRating
         path: /docs/reference/js/vertexai.safetyrating.md
       - title: SafetySetting
@@ -600,6 +596,8 @@ toc:
         path: /docs/reference/js/vertexai.vertexai.md
       - title: VertexAIError
         path: /docs/reference/js/vertexai.vertexaierror.md
+      - title: VertexAIModel
+        path: /docs/reference/js/vertexai.vertexaimodel.md
       - title: VertexAIOptions
         path: /docs/reference/js/vertexai.vertexaioptions.md
       - title: VideoMetadata

docs-devsite/vertexai.generativemodel.md

@@ -15,8 +15,9 @@ Class for generative model APIs.
 <b>Signature:</b>
 
 ```typescript
-export declare class GenerativeModel 
+export declare class GenerativeModel extends VertexAIModel 
 ```
+<b>Extends:</b> [VertexAIModel](./vertexai.vertexaimodel.md#vertexaimodel_class)
 
 ## Constructors
 
@@ -29,7 +30,6 @@ export declare class GenerativeModel
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [generationConfig](./vertexai.generativemodel.md#generativemodelgenerationconfig) |  | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) |  |
-|  [model](./vertexai.generativemodel.md#generativemodelmodel) |  | string |  |
 |  [requestOptions](./vertexai.generativemodel.md#generativemodelrequestoptions) |  | [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) |  |
 |  [safetySettings](./vertexai.generativemodel.md#generativemodelsafetysettings) |  | [SafetySetting](./vertexai.safetysetting.md#safetysetting_interface)<!-- -->\[\] |  |
 |  [systemInstruction](./vertexai.generativemodel.md#generativemodelsysteminstruction) |  | [Content](./vertexai.content.md#content_interface) |  |
@@ -71,14 +71,6 @@ constructor(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: Reque
 generationConfig: GenerationConfig;
 ```
 
-## GenerativeModel.model
-
-<b>Signature:</b>
-
-```typescript
-model: string;
-```
-
 ## GenerativeModel.requestOptions
 
 <b>Signature:</b>

docs-devsite/vertexai.imagengcsimage.md

@@ -10,27 +10,37 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGCSImage interface
-Image generated by Imagen, stored in Google Cloud Storage (GCS).
+An image generated by Imagen, stored in Google Cloud Storage (GCS).
 
 <b>Signature:</b>
 
 ```typescript
-export interface ImagenGCSImage extends ImagenImage 
+export interface ImagenGCSImage 
 ```
-<b>Extends:</b> ImagenImage
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The Google Cloud Storage (GCS) URI at which the generated image is stored. |
+|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string | The Google Cloud Storage (GCS) URI where the image is stored. |
+|  [mimeType](./vertexai.imagengcsimage.md#imagengcsimagemimetype) | string | The MIME type of the image. |
 
 ## ImagenGCSImage.gcsURI
 
-The Google Cloud Storage (GCS) URI at which the generated image is stored.
+The Google Cloud Storage (GCS) URI where the image is stored.
 
 <b>Signature:</b>
 
 ```typescript
 gcsURI: string;
 ```
+
+## ImagenGCSImage.mimeType
+
+The MIME type of the image.
+
+<b>Signature:</b>
+
+```typescript
+mimeType: string;
+```

docs-devsite/vertexai.imagengcsimageresponse.md

@@ -10,6 +10,8 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGCSImageResponse interface
+The response from a request to generate images to Google Cloud Storage (GCS).
+
 <b>Signature:</b>
 
 ```typescript
@@ -20,11 +22,13 @@ export interface ImagenGCSImageResponse
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [filteredReason](./vertexai.imagengcsimageresponse.md#imagengcsimageresponsefilteredreason) | string |  |
-|  [images](./vertexai.imagengcsimageresponse.md#imagengcsimageresponseimages) | [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface)<!-- -->\[\] |  |
+|  [filteredReason](./vertexai.imagengcsimageresponse.md#imagengcsimageresponsefilteredreason) | string | The reason why any images were filtered. This field is only present if one or more images were filtered. For the mappings of error codes to reasons, see [https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen\#safety-categories](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-categories)<!-- -->. |
+|  [images](./vertexai.imagengcsimageresponse.md#imagengcsimageresponseimages) | [ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface)<!-- -->\[\] | The images generated by Imagen. If all images were filtered due to safety reasons, this array will be empty. |
 
 ## ImagenGCSImageResponse.filteredReason
 
+The reason why any images were filtered. This field is only present if one or more images were filtered. For the mappings of error codes to reasons, see [https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen\#safety-categories](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-categories)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
@@ -33,6 +37,8 @@ filteredReason?: string;
 
 ## ImagenGCSImageResponse.images
 
+The images generated by Imagen. If all images were filtered due to safety reasons, this array will be empty.
+
 <b>Signature:</b>
 
 ```typescript

docs-devsite/vertexai.imagengenerationconfig.md

@@ -10,6 +10,8 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGenerationConfig interface
+Request-level configuration options for generating images with Imagen.
+
 <b>Signature:</b>
 
 ```typescript
@@ -20,12 +22,14 @@ export interface ImagenGenerationConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) |  |
-|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string |  |
-|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number |  |
+|  [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. |
 
 ## ImagenGenerationConfig.aspectRatio
 
+The aspect ratio of the generated images. Defaults to `1:1`<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
@@ -34,6 +38,8 @@ aspectRatio?: ImagenAspectRatio;
 
 ## ImagenGenerationConfig.negativePrompt
 
+A text prompt describing what should not be included in the image.
+
 <b>Signature:</b>
 
 ```typescript
@@ -42,6 +48,8 @@ negativePrompt?: string;
 
 ## ImagenGenerationConfig.numberOfImages
 
+The number of images to generate. Must be between 1 and 4. Defaults to 1.
+
 <b>Signature:</b>
 
 ```typescript

docs-devsite/vertexai.imagenimageformat.md

@@ -9,22 +9,35 @@ overwritten. Changes should be made in the source code at
 https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
-# ImagenImageFormat interface
+# ImagenImageFormat class
+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 [ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
-export interface ImagenImageFormat 
+export declare class ImagenImageFormat 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [compressionQuality](./vertexai.imagenimageformat.md#imagenimageformatcompressionquality) |  | number | The level of compression (a number between 0 and 100). |
+|  [mimeType](./vertexai.imagenimageformat.md#imagenimageformatmimetype) |  | string | The MIME type. |
+
+## Methods
+
+|  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [compressionQuality](./vertexai.imagenimageformat.md#imagenimageformatcompressionquality) | number |  |
-|  [mimeType](./vertexai.imagenimageformat.md#imagenimageformatmimetype) | string |  |
+|  [jpeg(compressionQuality)](./vertexai.imagenimageformat.md#imagenimageformatjpeg) | <code>static</code> | Creates an ImagenImageFormat for a JPEG image. |
+|  [png()](./vertexai.imagenimageformat.md#imagenimageformatpng) | <code>static</code> | Creates an ImageImageFormat for a PNG image. |
 
 ## ImagenImageFormat.compressionQuality
 
+The level of compression (a number between 0 and 100).
+
 <b>Signature:</b>
 
 ```typescript
@@ -33,8 +46,59 @@ compressionQuality?: number;
 
 ## ImagenImageFormat.mimeType
 
+The MIME type.
+
 <b>Signature:</b>
 
 ```typescript
 mimeType: string;
 ```
+
+## ImagenImageFormat.jpeg()
+
+Creates an ImagenImageFormat for a JPEG image.
+
+<b>Signature:</b>
+
+```typescript
+static jpeg(compressionQuality: number): ImagenImageFormat;
+```
+
+#### Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  compressionQuality | number | The level of compression (a number between 0 and 100). |
+
+<b>Returns:</b>
+
+[ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)
+
+ImagenImageFormat
+
+## ImagenImageFormat.png()
+
+Creates an ImageImageFormat for a PNG image.
+
+<b>Signature:</b>
+
+```typescript
+static png(): ImagenImageFormat;
+```
+<b>Returns:</b>
+
+[ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)
+
+ImageImageFormat
+
+### Example
+
+
+```javascript
+const imagenModelParams = {
+  // ... other ImagenModelParams
+  imageFormat: ImagenImageFormat.jpeg(75) // JPEG with a compression level of 75.
+}
+
+```
+