remove public docs

Author: dlarocque

common/api-review/vertexai.api.md

@@ -346,7 +346,7 @@ export class GenerativeModel extends VertexAIModel {
 // @public
 export function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
 
-// @public
+// @public (undocumented)
 export function getImagenModel(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
 // @public
@@ -430,88 +430,122 @@ export enum HarmSeverity {
     HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE"
 }
 
-// @public
+// @public (undocumented)
 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"
 }
 
-// @public
+// @public (undocumented)
 export interface ImagenGCSImage {
+    // (undocumented)
     gcsURI: string;
+    // (undocumented)
     mimeType: string;
 }
 
-// @public
+// @public (undocumented)
 export interface ImagenGenerationConfig {
+    // (undocumented)
     addWatermark?: boolean;
+    // (undocumented)
     aspectRatio?: ImagenAspectRatio;
+    // (undocumented)
     imageFormat?: ImagenImageFormat;
+    // (undocumented)
     negativePrompt?: string;
+    // (undocumented)
     numberOfImages?: number;
 }
 
-// @public
+// @public (undocumented)
 export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
+    // (undocumented)
     filteredReason?: string;
+    // (undocumented)
     images: T[];
 }
 
 // @public
 export class ImagenImageFormat {
+    // (undocumented)
     compressionQuality?: number;
+    // (undocumented)
     static jpeg(compressionQuality?: number): ImagenImageFormat;
+    // (undocumented)
     mimeType: string;
+    // (undocumented)
     static png(): ImagenImageFormat;
 }
 
 // @public
 export interface ImagenInlineImage {
+    // (undocumented)
     bytesBase64Encoded: string;
+    // (undocumented)
     mimeType: string;
 }
 
-// @public
+// @public (undocumented)
 export class ImagenModel extends VertexAIModel {
     constructor(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
-    // @beta
+    // (undocumented)
     generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
-    // @beta
+    // (undocumented)
     generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+    // (undocumented)
     generationConfig?: ImagenGenerationConfig;
     // (undocumented)
     requestOptions?: RequestOptions | undefined;
+    // (undocumented)
     safetySettings?: ImagenSafetySettings;
 }
 
-// @public
+// @public (undocumented)
 export interface ImagenModelParams {
+    // (undocumented)
     generationConfig?: ImagenGenerationConfig;
+    // (undocumented)
     model: string;
+    // (undocumented)
     safetySettings?: ImagenSafetySettings;
 }
 
-// @public
+// @public (undocumented)
 export enum ImagenPersonFilterLevel {
+    // (undocumented)
     ALLOW_ADULT = "allow_adult",
+    // (undocumented)
     ALLOW_ALL = "allow_all",
+    // (undocumented)
     BLOCK_ALL = "dont_allow"
 }
 
-// @public
+// @public (undocumented)
 export enum ImagenSafetyFilterLevel {
+    // (undocumented)
     BLOCK_LOW_AND_ABOVE = "block_low_and_above",
+    // (undocumented)
     BLOCK_MEDIUM_AND_ABOVE = "block_medium_and_above",
+    // (undocumented)
     BLOCK_NONE = "block_none",
+    // (undocumented)
     BLOCK_ONLY_HIGH = "block_only_high"
 }
 
-// @public
+// @public (undocumented)
 export interface ImagenSafetySettings {
+    // (undocumented)
     personFilterLevel?: ImagenPersonFilterLevel;
+    // (undocumented)
     safetyFilterLevel?: ImagenSafetyFilterLevel;
 }
 
@@ -804,12 +838,13 @@ export const enum VertexAIErrorCode {
     RESPONSE_ERROR = "response-error"
 }
 
-// @public
+// @public (undocumented)
 export abstract class VertexAIModel {
     // @internal
     protected constructor(vertexAI: VertexAI, modelName: string);
     // @internal (undocumented)
     protected _apiSettings: ApiSettings;
+    // (undocumented)
     readonly model: string;
     static normalizeModelName(modelName: string): string;
 }

docs-devsite/vertexai.imagengcsimage.md

@@ -10,8 +10,6 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGCSImage interface
-An image generated by Imagen, stored in Google Cloud Storage (GCS).
-
 <b>Signature:</b>
 
 ```typescript
@@ -22,13 +20,11 @@ export interface ImagenGCSImage
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [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. |
+|  [gcsURI](./vertexai.imagengcsimage.md#imagengcsimagegcsuri) | string |  |
+|  [mimeType](./vertexai.imagengcsimage.md#imagengcsimagemimetype) | string |  |
 
 ## ImagenGCSImage.gcsURI
 
-The Google Cloud Storage (GCS) URI where the image is stored.
-
 <b>Signature:</b>
 
 ```typescript
@@ -37,8 +33,6 @@ gcsURI: string;
 
 ## ImagenGCSImage.mimeType
 
-The MIME type of the image.
-
 <b>Signature:</b>
 
 ```typescript

docs-devsite/vertexai.imagengenerationconfig.md

@@ -10,10 +10,6 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # 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).
-
 <b>Signature:</b>
 
 ```typescript
@@ -24,16 +20,14 @@ export interface ImagenGenerationConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [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. |
+|  [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean |  |
+|  [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) |  |
+|  [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) |  |
+|  [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string |  |
+|  [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number |  |
 
 ## ImagenGenerationConfig.addWatermark
 
-If true, adds a SynthID watermark to the generated images.
-
 <b>Signature:</b>
 
 ```typescript
@@ -42,8 +36,6 @@ addWatermark?: boolean;
 
 ## ImagenGenerationConfig.aspectRatio
 
-The aspect ratio of the generated images. The default value is 1:1. used.
-
 <b>Signature:</b>
 
 ```typescript
@@ -52,8 +44,6 @@ aspectRatio?: ImagenAspectRatio;
 
 ## ImagenGenerationConfig.imageFormat
 
-The image format of the generated images. The default is PNG.
-
 <b>Signature:</b>
 
 ```typescript
@@ -62,8 +52,6 @@ imageFormat?: ImagenImageFormat;
 
 ## ImagenGenerationConfig.negativePrompt
 
-A description of what should be omitted from the generated images.
-
 <b>Signature:</b>
 
 ```typescript
@@ -72,8 +60,6 @@ negativePrompt?: string;
 
 ## ImagenGenerationConfig.numberOfImages
 
-The number of images to generate. Must be between 1 and 4. The default value is 1.
-
 <b>Signature:</b>
 
 ```typescript

docs-devsite/vertexai.imagengenerationresponse.md

@@ -10,8 +10,6 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenGenerationResponse interface
-The response from a request to generate images with Imagen.
-
 <b>Signature:</b>
 
 ```typescript
@@ -22,13 +20,11 @@ export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGC
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [filteredReason](./vertexai.imagengenerationresponse.md#imagengenerationresponsefilteredreason) | 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.imagengenerationresponse.md#imagengenerationresponseimages) | T\[\] | The images generated by Imagen. If all images were filtered due to safety reasons, this array will be empty. |
+|  [filteredReason](./vertexai.imagengenerationresponse.md#imagengenerationresponsefilteredreason) | string |  |
+|  [images](./vertexai.imagengenerationresponse.md#imagengenerationresponseimages) | T\[\] |  |
 
 ## ImagenGenerationResponse.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
@@ -37,8 +33,6 @@ filteredReason?: string;
 
 ## ImagenGenerationResponse.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.imagenimageformat.md

@@ -10,9 +10,13 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ImagenImageFormat class
-Defines the image format for images output by Imagen.
+ Copyright 2025 Google LLC
 
-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)<!-- -->.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
 <b>Signature:</b>
 
@@ -24,20 +28,18 @@ export declare class ImagenImageFormat
 
 |  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. |
+|  [compressionQuality](./vertexai.imagenimageformat.md#imagenimageformatcompressionquality) |  | number |  |
+|  [mimeType](./vertexai.imagenimageformat.md#imagenimageformatmimetype) |  | string |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [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. |
+|  [jpeg(compressionQuality)](./vertexai.imagenimageformat.md#imagenimageformatjpeg) | <code>static</code> |  |
+|  [png()](./vertexai.imagenimageformat.md#imagenimageformatpng) | <code>static</code> |  |
 
 ## ImagenImageFormat.compressionQuality
 
-The level of compression (a number between 0 and 100).
-
 <b>Signature:</b>
 
 ```typescript
@@ -46,8 +48,6 @@ compressionQuality?: number;
 
 ## ImagenImageFormat.mimeType
 
-The MIME type.
-
 <b>Signature:</b>
 
 ```typescript
@@ -56,8 +56,6 @@ mimeType: string;
 
 ## ImagenImageFormat.jpeg()
 
-Creates an ImagenImageFormat for a JPEG image.
-
 <b>Signature:</b>
 
 ```typescript
@@ -68,18 +66,14 @@ static jpeg(compressionQuality?: number): ImagenImageFormat;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  compressionQuality | number | The level of compression (a number between 0 and 100). |
+|  compressionQuality | number |  |
 
 <b>Returns:</b>
 
 [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)
 
-ImagenImageFormat
-
 ## ImagenImageFormat.png()
 
-Creates an ImageImageFormat for a PNG image.
-
 <b>Signature:</b>
 
 ```typescript
@@ -89,16 +83,3 @@ static png(): ImagenImageFormat;
 
 [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)
 
-ImageImageFormat
-
-### Example
-
-
-```javascript
-const imagenModelParams = {
-  // ... other ImagenModelParams
-  imageFormat: ImagenImageFormat.jpeg(75) // JPEG with a compression level of 75.
-}
-
-```
-