@firebase/ai 2.10.0 → 2.11.0-20260408221811

package/dist/ai.d.ts

@@ -352,19 +352,61 @@ export declare class BooleanSchema extends Schema {
  *
  * @public
  */
-export declare class ChatSession {
+export declare class ChatSession extends ChatSessionBase<StartChatParams, GenerateContentRequest, FunctionDeclarationsTool> {
     model: string;
     private chromeAdapter?;
     params?: StartChatParams | undefined;
     requestOptions?: RequestOptions | undefined;
-    private _apiSettings;
-    private _history;
+    constructor(apiSettings: ApiSettings, model: string, chromeAdapter?: ChromeAdapter | undefined, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
+    /**
+     * Format Content into a request for generateContent or
+     * generateContentStream.
+     * @internal
+     */
+    _formatRequest(incomingContent: Content, tempHistory: Content[]): GenerateContentRequest;
+    /**
+     * Calls default generateContent() (versus a specialized one like
+     * templateGenerateContent).
+     * @internal
+     */
+    _callGenerateContent(formattedRequest: GenerateContentRequest, singleRequestOptions?: RequestOptions): Promise<GenerateContentResult>;
+    /**
+     * Calls default generateContentStream() (versus a specialized one like
+     * templateGenerateContentStream).
+     * @internal
+     */
+    _callGenerateContentStream(formattedRequest: GenerateContentRequest, singleRequestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
+    /**
+     * Sends a chat message and receives a non-streaming
+     * {@link GenerateContentResult}
+     */
+    sendMessage(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
+    /**
+     * Sends a chat message and receives the response as a
+     * {@link GenerateContentStreamResult} containing an iterable stream
+     * and a response promise.
+     */
+    sendMessageStream(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+}
+
+/**
+ * Base class for various `ChatSession` classes that enables sending chat
+ * messages and stores history of sent and received messages so far.
+ *
+ * @public
+ */
+export declare abstract class ChatSessionBase<ParamsType extends StartChatParams | StartTemplateChatParams, RequestType, FunctionDeclarationsToolType extends FunctionDeclarationsTool | TemplateFunctionDeclarationsTool> {
+    params?: ParamsType | undefined;
+    requestOptions?: RequestOptions | undefined;
+    protected _apiSettings: ApiSettings;
+    protected _history: Content[];
     /**
      * Ensures sequential execution of chat messages to maintain history order.
      * Each call waits for the previous one to settle before proceeding.
+     * @internal
      */
-    private _sendPromise;
-    constructor(apiSettings: ApiSettings, model: string, chromeAdapter?: ChromeAdapter | undefined, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
+    protected _sendPromise: Promise<void>;
+    constructor(apiSettings: ApiSettings, params?: ParamsType | undefined, requestOptions?: RequestOptions | undefined);
     /**
      * Gets the chat history so far. Blocked prompts are not added to history.
      * Neither blocked candidates nor the prompts that generated them are added
@@ -372,22 +414,36 @@ export declare class ChatSession {
      */
     getHistory(): Promise<Content[]>;
     /**
-     * Format Content into a request for generateContent or
-     * generateContentStream.
+     * Format Content into a request for `generateContent` or
+     * `generateContentStream` (or their template versions).
      * @internal
      */
-    _formatRequest(incomingContent: Content, tempHistory: Content[]): GenerateContentRequest;
+    abstract _formatRequest(incomingContent: Content, tempHistory: Content[]): RequestType;
+    /**
+     * Type-specific generate content calls (inherited classes may implement this
+     * to call basic `generateContent()` or the template version)
+     * @internal
+     */
+    abstract _callGenerateContent(formattedRequest: RequestType, singleRequestOptions?: RequestOptions): Promise<GenerateContentResult>;
+    /**
+     * Type-specific generate content stream calls (inherited classes may implement this
+     * to call basic `generateContentStream()` or the template version)
+     * @internal
+     */
+    abstract _callGenerateContentStream(formattedRequest: RequestType, singleRequestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
     /**
      * Sends a chat message and receives a non-streaming
      * {@link GenerateContentResult}
+     * @internal
      */
-    sendMessage(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
+    _sendMessage(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
     /**
      * Sends a chat message and receives the response as a
      * {@link GenerateContentStreamResult} containing an iterable stream
      * and a response promise.
+     * @internal
      */
-    sendMessageStream(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+    _sendMessageStream(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
     /**
      * Get function calls that the SDK has references to actually call.
      * This is all-or-nothing. If the model is requesting multiple
@@ -1162,6 +1218,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.
@@ -1202,10 +1263,13 @@ 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;
 
@@ -1550,6 +1614,11 @@ export declare interface HybridParams {
  * 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: {
@@ -1584,6 +1653,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 declare type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];
@@ -1592,6 +1666,12 @@ export declare type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof
  * 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 declare interface ImagenGCSImage {
@@ -1615,6 +1695,11 @@ export declare interface ImagenGCSImage {
  * 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 declare interface ImagenGenerationConfig {
@@ -1667,6 +1752,11 @@ export declare interface ImagenGenerationConfig {
 /**
  * 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 declare interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
@@ -1722,6 +1812,11 @@ export declare interface ImagenGenerationResponse<T extends ImagenInlineImage |
  * }
  * ```
  *
+ * @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 {
@@ -1772,6 +1867,11 @@ export declare class ImagenImageFormat {
 /**
  * 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 declare interface ImagenInlineImage {
@@ -1807,6 +1907,11 @@ export declare interface ImagenInlineImage {
  * }
  * ```
  *
+ * @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 {
@@ -1874,6 +1979,11 @@ export declare class ImagenModel extends AIModel {
 /**
  * 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 declare interface ImagenModelParams {
@@ -1903,6 +2013,11 @@ export declare interface ImagenModelParams {
  * 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: {
@@ -1934,6 +2049,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 declare type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
@@ -1948,6 +2068,11 @@ export declare type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[k
  * 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: {
@@ -1982,6 +2107,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 declare type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
@@ -1992,6 +2122,11 @@ export declare type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[k
  * 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 declare interface ImagenSafetySettings {
@@ -2110,7 +2245,13 @@ export declare type Language = (typeof Language)[keyof typeof Language];
  * @beta
  */
 export declare interface LanguageModelCreateCoreOptions {
+    /**
+     * @deprecated
+     */
     topK?: number;
+    /**
+     * @deprecated
+     */
     temperature?: number;
     expectedInputs?: LanguageModelExpected[];
 }
@@ -2721,7 +2862,7 @@ export declare interface RequestOptions {
      * When it reaches this limit, it will return the last response received
      * from the model, whether it is a text response or further function calls.
      */
-    maxSequentalFunctionCalls?: number;
+    maxSequentialFunctionCalls?: number;
 }
 
 /**
@@ -3194,6 +3335,22 @@ export declare interface StartChatParams extends BaseParams {
     systemInstruction?: string | Part | Content;
 }
 
+/**
+ * Params for {@link TemplateGenerativeModel.startChat}.
+ * @beta
+ */
+export declare interface StartTemplateChatParams extends Omit<StartChatParams, 'tools'> {
+    /**
+     * The ID of the server-side template to execute.
+     */
+    templateId: string;
+    /**
+     * A key-value map of variables to populate the template with.
+     */
+    templateVariables?: Record<string, unknown>;
+    tools?: TemplateTool[];
+}
+
 /**
  * Schema class for "string" types. Can be used with or without
  * enum values.
@@ -3208,6 +3365,122 @@ export declare class StringSchema extends Schema {
     toJSON(): SchemaRequest;
 }
 
+/**
+ * `ChatSession` class for use with server prompt templates that
+ * enables sending chat messages and stores history of sent and
+ * received messages so far.
+ *
+ * @beta
+ */
+export declare class TemplateChatSession extends ChatSessionBase<StartTemplateChatParams, TemplateRequestInternal, TemplateFunctionDeclarationsTool> {
+    params: StartTemplateChatParams;
+    requestOptions?: RequestOptions | undefined;
+    constructor(apiSettings: ApiSettings, params: StartTemplateChatParams, requestOptions?: RequestOptions | undefined);
+    /**
+     * Format the internal state to the body payload for `templateGenerateContent`.
+     * @internal
+     */
+    _formatRequest(incomingContent: Content, tempHistory: Content[]): TemplateRequestInternal;
+    /**
+     * Calls the specific templateGenerateContent() function needed for
+     * this specialized TemplateChatSession.
+     * @internal
+     */
+    _callGenerateContent(formattedRequest: TemplateRequestInternal, singleRequestOptions?: RequestOptions): Promise<GenerateContentResult>;
+    /**
+     * Calls the specific templateGenerateContentStream() function needed for
+     * this specialized TemplateChatSession.
+     * @internal
+     */
+    _callGenerateContentStream(formattedRequest: TemplateRequestInternal, singleRequestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
+    /**
+     * Sends a chat message and receives a non-streaming
+     * {@link GenerateContentResult}
+     */
+    sendMessage(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
+    /**
+     * Sends a chat message and receives the response as a
+     * {@link GenerateContentStreamResult} containing an iterable stream
+     * and a response promise.
+     */
+    sendMessageStream(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+}
+
+/**
+ * Structured representation of a template function declaration.
+ * Included in this declaration are the function name and parameters. This
+ * `TemplateFunctionDeclaration` is a representation of a block of code that can be used
+ * as a Tool by the model and executed by the client.
+ * Note: Template function declarations do not support description fields.
+ * @beta
+ */
+export declare interface TemplateFunctionDeclaration {
+    /**
+     * The name of the function to call. Must start with a letter or an
+     * underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with
+     * a max length of 64.
+     */
+    name: string;
+    /**
+     * Description is intentionally unsupported for template function declarations.
+     */
+    description?: never;
+    /**
+     * Optional. Describes the parameters to this function in JSON Schema Object
+     * format. Reflects the Open API 3.03 Parameter Object. Parameter names are
+     * case-sensitive. For a function with no parameters, this can be left unset.
+     */
+    parameters?: ObjectSchema | ObjectSchemaRequest;
+    /**
+     * Reference to an actual function to call. Specifying this will cause the
+     * function to be called automatically when requested by the model.
+     */
+    functionReference?: Function;
+}
+
+/**
+ * @internal
+ */
+export declare interface TemplateFunctionDeclarationInternal extends Omit<TemplateFunctionDeclaration, 'parameters'> {
+    inputSchema?: ObjectSchema | ObjectSchemaRequest;
+}
+
+/**
+ * A piece of code that enables the system to interact with external systems.
+ * @beta
+ */
+export declare interface TemplateFunctionDeclarationsTool {
+    /**
+     * Optional. One or more function declarations
+     * to be passed to the server-side template execution.
+     */
+    functionDeclarations?: TemplateFunctionDeclaration[];
+}
+
+/**
+ * The modified interface for the tool that is sent to the backend.
+ * @internal
+ */
+export declare interface TemplateFunctionDeclarationsToolInternal {
+    /**
+     * Optional. One or more function declarations
+     * to be passed to the server-side template execution.
+     */
+    templateFunctions?: TemplateFunctionDeclarationInternal[];
+}
+
+/**
+ * Request sent through {@link TemplateGenerativeModel.generateContent}
+ * @beta
+ */
+export declare interface TemplateGenerateContentRequest {
+    inputs?: Record<string, unknown>;
+    history?: Content[];
+    tools?: TemplateFunctionDeclarationsTool[];
+    toolConfig?: ToolConfig;
+    [key: string]: unknown;
+}
+
 /**
  * {@link GenerativeModel} APIs that execute on a server-side template.
  *
@@ -3238,7 +3511,7 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContent(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
+    generateContent(templateId: string, templateVariables: Record<string, unknown>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
     /**
      * Makes a single streaming call to the model and returns an object
      * containing an iterable stream that iterates over all chunks in the
@@ -3251,7 +3524,17 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContentStream(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+    generateContentStream(templateId: string, templateVariables: Record<string, unknown>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+    /**
+     * Starts a {@link TemplateChatSession} that will use this template to
+     * respond to messages.
+     *
+     * @param params - Configurations for the chat, including the template
+     * ID and input variables.
+     *
+     * @beta
+     */
+    startChat(params: StartTemplateChatParams): TemplateChatSession;
 }
 
 /**
@@ -3259,7 +3542,10 @@ export declare 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)}.
  */
 export declare class TemplateImagenModel {
     /**
@@ -3287,6 +3573,22 @@ export declare class TemplateImagenModel {
     generateImages(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
 }
 
+/**
+ * Internal version of the template generate content request.
+ * @internal
+ */
+export declare interface TemplateRequestInternal extends Omit<TemplateGenerateContentRequest, 'tools'> {
+    tools?: TemplateFunctionDeclarationsToolInternal[];
+}
+
+/**
+ * Defines a tool that a {@link TemplateGenerativeModel} can call
+ * to access external knowledge.
+ * Only function declarations are currently supported for templates.
+ * @beta
+ */
+export declare type TemplateTool = TemplateFunctionDeclarationsTool;
+
 /**
  * Content part interface if the part represents a text string.
  * @public