@firebase/ai 2.10.0-canary.ba0bc39bb → 2.10.0-canary.bfb9accdc

package/dist/esm/src/api.d.ts

@@ -76,6 +76,11 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams | Hy
  *
  * Only Imagen 3 models (named `imagen-3.0-*`) are supported.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @param ai - An {@link AI} instance.
  * @param modelParams - Parameters to use when making Imagen requests.
  * @param requestOptions - Additional options to use when making requests.
@@ -113,9 +118,12 @@ export declare function getTemplateGenerativeModel(ai: AI, requestOptions?: Requ
  * Returns a {@link TemplateImagenModel} class for executing server-side
  * Imagen templates.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @param ai - An {@link AI} instance.
  * @param requestOptions - Additional options to use when making requests.
- *
- * @beta
  */
 export declare function getTemplateImagenModel(ai: AI, requestOptions?: RequestOptions): TemplateImagenModel;

package/dist/esm/src/models/generative-model.d.ts

@@ -54,3 +54,8 @@ export declare class GenerativeModel extends AIModel {
      */
     countTokens(request: CountTokensRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<CountTokensResponse>;
 }
+/**
+ * Client-side validation of some common `GenerationConfig` pitfalls, in order
+ * to save the developer a wasted request.
+ */
+export declare function validateGenerationConfig(generationConfig: GenerationConfig): void;

package/dist/esm/src/models/imagen-model.d.ts

@@ -37,6 +37,11 @@ import { AIModel } from './ai-model';
  * }
  * ```
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export declare class ImagenModel extends AIModel {

package/dist/esm/src/models/template-imagen-model.d.ts

@@ -22,7 +22,10 @@ import { ApiSettings } from '../types/internal';
  *
  * This class should only be instantiated with {@link getTemplateImagenModel}.
  *
- * @beta
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
  */
 export declare class TemplateImagenModel {
     /**

package/dist/esm/src/requests/imagen-image-format.d.ts

@@ -29,6 +29,11 @@
  * }
  * ```
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export declare class ImagenImageFormat {

package/dist/esm/src/types/imagen/requests.d.ts

@@ -18,6 +18,11 @@ import { ImagenImageFormat } from '../../requests/imagen-image-format';
 /**
  * Parameters for configuring an {@link ImagenModel}.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenModelParams {
@@ -46,6 +51,11 @@ export interface ImagenModelParams {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
  * more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenGenerationConfig {
@@ -104,6 +114,11 @@ export interface ImagenGenerationConfig {
  * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
  * for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export declare const ImagenSafetyFilterLevel: {
@@ -137,6 +152,11 @@ export declare const ImagenSafetyFilterLevel: {
  * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
  * for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
@@ -146,6 +166,11 @@ export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typ
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export declare const ImagenPersonFilterLevel: {
@@ -176,6 +201,11 @@ export declare const ImagenPersonFilterLevel: {
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
@@ -185,6 +215,11 @@ export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typ
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenSafetySettings {
@@ -207,6 +242,11 @@ export interface ImagenSafetySettings {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export declare const ImagenAspectRatio: {
@@ -240,6 +280,11 @@ export declare const ImagenAspectRatio: {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];

package/dist/esm/src/types/imagen/responses.d.ts

@@ -17,6 +17,11 @@
 /**
  * An image generated by Imagen, represented as inline data.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenInlineImage {
@@ -35,6 +40,12 @@ export interface ImagenInlineImage {
  * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
  *
  * This feature is not available yet.
+ *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenGCSImage {
@@ -54,6 +65,11 @@ export interface ImagenGCSImage {
 /**
  * The response from a request to generate images with Imagen.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {

package/dist/index.cjs.js

@@ -8,7 +8,7 @@ var util = require('@firebase/util');
 var logger$1 = require('@firebase/logger');
 
 var name = "@firebase/ai";
-var version = "2.10.0-canary.ba0bc39bb";
+var version = "2.10.0-canary.bfb9accdc";
 
 /**
  * @license
@@ -609,6 +609,11 @@ const SchemaType = {
  * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
  * for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 const ImagenSafetyFilterLevel = {
@@ -638,6 +643,11 @@ const ImagenSafetyFilterLevel = {
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 const ImagenPersonFilterLevel = {
@@ -671,6 +681,11 @@ const ImagenPersonFilterLevel = {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 const ImagenAspectRatio = {
@@ -3146,8 +3161,9 @@ function validateGenerationConfig(generationConfig) {
     }
     if ((generationConfig.responseSchema != null ||
         generationConfig.responseJsonSchema != null) &&
-        generationConfig.responseMimeType) {
-        throw new AIError(AIErrorCode.UNSUPPORTED, `responseMimeType must be set if responseSchema or responseJsonSchema are set.`);
+        generationConfig.responseMimeType !== 'application/json') {
+        throw new AIError(AIErrorCode.UNSUPPORTED, `responseMimeType must be set to "application/json" if` +
+            ` responseSchema or responseJsonSchema are set.`);
     }
 }
 
@@ -3579,6 +3595,11 @@ class LiveGenerativeModel extends AIModel {
  * }
  * ```
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 class ImagenModel extends AIModel {
@@ -3910,7 +3931,10 @@ class TemplateGenerativeModel {
  *
  * This class should only be instantiated with {@link getTemplateImagenModel}.
  *
- * @beta
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
  */
 class TemplateImagenModel {
     /**
@@ -4219,6 +4243,11 @@ class AnyOfSchema extends Schema {
  * }
  * ```
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @public
  */
 class ImagenImageFormat {
@@ -4719,6 +4748,11 @@ function getGenerativeModel(ai, modelParams, requestOptions) {
  *
  * Only Imagen 3 models (named `imagen-3.0-*`) are supported.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @param ai - An {@link AI} instance.
  * @param modelParams - Parameters to use when making Imagen requests.
  * @param requestOptions - Additional options to use when making requests.
@@ -4769,10 +4803,13 @@ function getTemplateGenerativeModel(ai, requestOptions) {
  * Returns a {@link TemplateImagenModel} class for executing server-side
  * Imagen templates.
  *
+ * @deprecated All Imagen models are deprecated and will shut down as
+ * early as June 2026. As a replacement, you can
+ * {@link https://firebase.google.com/docs/ai-logic/imagen-models-migration |
+ * migrate your apps to use Gemini Image models (the "Nano Banana" models)}.
+ *
  * @param ai - An {@link AI} instance.
  * @param requestOptions - Additional options to use when making requests.
- *
- * @beta
  */
 function getTemplateImagenModel(ai, requestOptions) {
     return new TemplateImagenModel(ai, requestOptions);