update

Author: dlarocque

.changeset/violet-planets-impress.md

@@ -1,4 +1,5 @@
 ---
+'firebase': minor
 '@firebase/vertexai': minor
 ---
 

packages/vertexai/src/api.ts

@@ -84,6 +84,10 @@ export function getGenerativeModel(
 
 /**
  * Returns a <code>{@link ImagenModel}</code> class with methods for using Imagen.
+ * 
+ * @beta
+ * This feature is in public preview and is not intended for production use.
+ * The API is subject to change.
  *
  * @public
  */

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

@@ -58,11 +58,11 @@ export class ImagenModel extends VertexAIModel {
   /**
    * The Imagen Generation Configuration.
    */
-  readonly generationConfig?: ImagenGenerationConfig;
+  generationConfig?: ImagenGenerationConfig;
   /**
    * Safety settings for filtering inappropriate content.
    */
-  readonly safetySettings?: ImagenSafetySettings;
+  safetySettings?: ImagenSafetySettings;
 
   /**
    * Constructs a new instance of the {@link ImagenModel} class.
@@ -77,7 +77,7 @@ export class ImagenModel extends VertexAIModel {
   constructor(
     vertexAI: VertexAI,
     modelParams: ImagenModelParams,
-    readonly requestOptions?: RequestOptions
+    public requestOptions?: RequestOptions
   ) {
     const { model, generationConfig, safetySettings } = modelParams;
     super(vertexAI, model);
@@ -88,6 +88,10 @@ export class ImagenModel extends VertexAIModel {
   /**
    * Generates images using the Imagen model and returns them as
    * base64-encoded strings.
+   * 
+   * @beta
+   * This feature is in public preview and is not intended for production use.
+   * The API is subject to change.
    *
    * @param prompt - The text prompt used to generate the images.
    * @returns A promise that resolves to an {@link ImagenGenerationResponse}
@@ -121,6 +125,10 @@ export class ImagenModel extends VertexAIModel {
 
   /**
    * Generates images to Google Cloud Storage (GCS) using the Imagen model.
+   * 
+   * @beta
+   * This feature is in public preview and is not intended for production use.
+   * The API is subject to change.
    *
    * @param prompt - The text prompt used to generate the images.
    * @param gcsURI - The GCS URI where the images should be stored.

packages/vertexai/src/requests/imagen-image-format.ts

@@ -20,7 +20,7 @@
  *
  * 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
- * {@link ImagenModelParams}.
+ * <code>{@link ImagenModelParams}</code>.
  *
  * @example
  * ```javascript
@@ -47,10 +47,14 @@ export class ImagenImageFormat {
   }
 
   /**
-   * Creates an ImagenImageFormat for a JPEG image.
+   * Creates an <code>{@link ImagenImageFormat}</code> for a JPEG image.
+   * 
+   * @beta
+   * This feature is in public preview and is not intended for production use.
+   * The API is subject to change.
    *
    * @param compressionQuality - The level of compression (a number between 0 and 100).
-   * @returns ImagenImageFormat
+   * @returns An <code>{@link ImagenImageFormat}</code> object for a JPEG image.
    *
    * @public
    */
@@ -59,9 +63,13 @@ export class ImagenImageFormat {
   }
 
   /**
-   * Creates an ImageImageFormat for a PNG image.
+   * Creates an <code>{@link ImagenImageFormat}</code> for a PNG image.
+   * 
+   * @beta
+   * This feature is in public preview and is not intended for production use.
+   * The API is subject to change.
    *
-   * @returns ImageImageFormat
+   * @returns An <code>{@link ImagenImageFormat}</code> object for a PNG image.
    *
    * @public
    */