@firebase/ai 2.5.0 → 2.6.0-20251112180857

package/dist/src/api.d.ts

@@ -21,11 +21,13 @@ import { AI, AIOptions } from './public-types';
 import { ImagenModelParams, HybridParams, ModelParams, RequestOptions, LiveModelParams } from './types';
 import { AIError } from './errors';
 import { AIModel, GenerativeModel, LiveGenerativeModel, ImagenModel } from './models';
+import { TemplateGenerativeModel } from './models/template-generative-model';
+import { TemplateImagenModel } from './models/template-imagen-model';
 export { ChatSession } from './methods/chat-session';
 export { LiveSession } from './methods/live-session';
 export * from './requests/schema-builder';
 export { ImagenImageFormat } from './requests/imagen-image-format';
-export { AIModel, GenerativeModel, LiveGenerativeModel, ImagenModel, AIError };
+export { AIModel, GenerativeModel, LiveGenerativeModel, ImagenModel, TemplateGenerativeModel, TemplateImagenModel, AIError };
 export { Backend, VertexAIBackend, GoogleAIBackend } from './backend';
 export { startAudioConversation, AudioConversationController, StartAudioConversationOptions } from './methods/live-session-helpers';
 declare module '@firebase/component' {
@@ -97,3 +99,23 @@ export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, r
  * @beta
  */
 export declare function getLiveGenerativeModel(ai: AI, modelParams: LiveModelParams): LiveGenerativeModel;
+/**
+ * Returns a {@link TemplateGenerativeModel} class for executing server-side
+ * templates.
+ *
+ * @param ai - An {@link AI} instance.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @beta
+ */
+export declare function getTemplateGenerativeModel(ai: AI, requestOptions?: RequestOptions): TemplateGenerativeModel;
+/**
+ * Returns a {@link TemplateImagenModel} class for executing server-side
+ * Imagen templates.
+ *
+ * @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/src/backend.d.ts

@@ -33,6 +33,14 @@ export declare abstract class Backend {
      * @param type - The backend type.
      */
     protected constructor(type: BackendType);
+    /**
+     * @internal
+     */
+    abstract _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    abstract _getTemplatePath(project: string, templateId: string): string;
 }
 /**
  * Configuration class for the Gemini Developer API.
@@ -47,6 +55,14 @@ export declare class GoogleAIBackend extends Backend {
      * Creates a configuration object for the Gemini Developer API backend.
      */
     constructor();
+    /**
+     * @internal
+     */
+    _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    _getTemplatePath(project: string, templateId: string): string;
 }
 /**
  * Configuration class for the Vertex AI Gemini API.
@@ -71,4 +87,12 @@ export declare class VertexAIBackend extends Backend {
      * for a list of supported locations.
      */
     constructor(location?: string);
+    /**
+     * @internal
+     */
+    _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    _getTemplatePath(project: string, templateId: string): string;
 }

package/dist/src/constants.d.ts

@@ -17,6 +17,7 @@
 export declare const AI_TYPE = "AI";
 export declare const DEFAULT_LOCATION = "us-central1";
 export declare const DEFAULT_DOMAIN = "firebasevertexai.googleapis.com";
+export declare const STAGING_URL = "https://staging-firebasevertexai.sandbox.googleapis.com";
 export declare const DEFAULT_API_VERSION = "v1beta";
 export declare const PACKAGE_VERSION: string;
 export declare const LANGUAGE_TAG = "gl-js";

package/dist/src/factory-node.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * 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.
+ */
+import { ComponentContainer, InstanceFactoryOptions } from '@firebase/component';
+import { AIService } from './service';
+export declare function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;

package/dist/src/methods/generate-content.d.ts

@@ -18,4 +18,6 @@ import { GenerateContentRequest, GenerateContentResult, GenerateContentStreamRes
 import { ApiSettings } from '../types/internal';
 import { ChromeAdapter } from '../types/chrome-adapter';
 export declare function generateContentStream(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, requestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
+export declare function templateGenerateContent(apiSettings: ApiSettings, templateId: string, templateParams: object, requestOptions?: RequestOptions): Promise<GenerateContentResult>;
+export declare function templateGenerateContentStream(apiSettings: ApiSettings, templateId: string, templateParams: object, requestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
 export declare function generateContent(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, requestOptions?: RequestOptions): Promise<GenerateContentResult>;

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

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * 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.
+ */
+import { GenerateContentResult, RequestOptions } from '../types';
+import { AI, GenerateContentStreamResult } from '../public-types';
+import { ApiSettings } from '../types/internal';
+/**
+ * {@link GenerativeModel} APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateGenerativeModel}.
+ *
+ * @beta
+ */
+export declare class TemplateGenerativeModel {
+    /**
+     * @internal
+     */
+    _apiSettings: ApiSettings;
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single non-streaming call to the model and returns an object
+     * containing a single {@link GenerateContentResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContent(templateId: string, templateVariables: object): 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
+     * streaming response as well as a promise that returns the final aggregated
+     * response.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+}

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

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * 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.
+ */
+import { RequestOptions } from '../types';
+import { AI, ImagenGenerationResponse, ImagenInlineImage } from '../public-types';
+import { ApiSettings } from '../types/internal';
+/**
+ * Class for Imagen model APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateImagenModel}.
+ *
+ * @beta
+ */
+export declare class TemplateImagenModel {
+    /**
+     * @internal
+     */
+    _apiSettings: ApiSettings;
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single call to the model and returns an object containing a single
+     * {@link ImagenGenerationResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+}

package/dist/src/models/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * 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.
+ */
+import { AI } from '../public-types';
+import { ApiSettings } from '../types/internal';
+/**
+ * Initializes an {@link ApiSettings} object from an {@link AI} instance.
+ *
+ * If this is a Server App, the {@link ApiSettings} object's `getAppCheckToken()` will resolve
+ * with the `FirebaseServerAppSettings.appCheckToken`, instead of requiring that an App Check
+ * instance is initialized.
+ */
+export declare function initApiSettings(ai: AI): ApiSettings;

package/dist/src/requests/request.d.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,23 +16,44 @@
  */
 import { RequestOptions } from '../types';
 import { ApiSettings } from '../types/internal';
-export declare enum Task {
+export declare const enum Task {
     GENERATE_CONTENT = "generateContent",
     STREAM_GENERATE_CONTENT = "streamGenerateContent",
     COUNT_TOKENS = "countTokens",
     PREDICT = "predict"
 }
-export declare class RequestUrl {
-    model: string;
-    task: Task;
+export declare const enum ServerPromptTemplateTask {
+    TEMPLATE_GENERATE_CONTENT = "templateGenerateContent",
+    TEMPLATE_STREAM_GENERATE_CONTENT = "templateStreamGenerateContent",
+    TEMPLATE_PREDICT = "templatePredict"
+}
+interface BaseRequestURLParams {
     apiSettings: ApiSettings;
     stream: boolean;
-    requestOptions?: RequestOptions | undefined;
-    constructor(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, requestOptions?: RequestOptions | undefined);
+    requestOptions?: RequestOptions;
+}
+/**
+ * Parameters used to construct the URL of a request to use a model.
+ */
+interface ModelRequestURLParams extends BaseRequestURLParams {
+    task: Task;
+    model: string;
+    templateId?: never;
+}
+/**
+ * Parameters used to construct the URL of a request to use server side prompt templates.
+ */
+interface TemplateRequestURLParams extends BaseRequestURLParams {
+    task: ServerPromptTemplateTask;
+    templateId: string;
+    model?: never;
+}
+export declare class RequestURL {
+    readonly params: ModelRequestURLParams | TemplateRequestURLParams;
+    constructor(params: ModelRequestURLParams | TemplateRequestURLParams);
     toString(): string;
+    private get pathname();
     private get baseUrl();
-    private get apiVersion();
-    private get modelPath();
     private get queryParams();
 }
 export declare class WebSocketUrl {
@@ -41,9 +62,6 @@ export declare class WebSocketUrl {
     toString(): string;
     private get pathname();
 }
-export declare function getHeaders(url: RequestUrl): Promise<Headers>;
-export declare function constructRequest(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, body: string, requestOptions?: RequestOptions): Promise<{
-    url: string;
-    fetchOptions: RequestInit;
-}>;
-export declare function makeRequest(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, body: string, requestOptions?: RequestOptions): Promise<Response>;
+export declare function getHeaders(url: RequestURL): Promise<Headers>;
+export declare function makeRequest(requestUrlParams: TemplateRequestURLParams | ModelRequestURLParams, body: string): Promise<Response>;
+export {};

package/dist/src/service.d.ts

@@ -15,21 +15,20 @@
  * limitations under the License.
  */
 import { FirebaseApp, _FirebaseService } from '@firebase/app';
-import { AI, AIOptions, InferenceMode, OnDeviceParams } from './public-types';
+import { AI, AIOptions, ChromeAdapter, InferenceMode, OnDeviceParams } from './public-types';
 import { AppCheckInternalComponentName, FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
 import { Provider } from '@firebase/component';
 import { FirebaseAuthInternal, FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Backend } from './backend';
-import { ChromeAdapterImpl } from './methods/chrome-adapter';
 export declare class AIService implements AI, _FirebaseService {
     app: FirebaseApp;
     backend: Backend;
-    chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapterImpl | undefined) | undefined;
+    chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapter | undefined) | undefined;
     auth: FirebaseAuthInternal | null;
     appCheck: FirebaseAppCheckInternal | null;
     _options?: Omit<AIOptions, 'backend'>;
     location: string;
-    constructor(app: FirebaseApp, backend: Backend, authProvider?: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>, chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapterImpl | undefined) | undefined);
+    constructor(app: FirebaseApp, backend: Backend, authProvider?: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>, chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapter | undefined) | undefined);
     _delete(): Promise<void>;
     set options(optionsToSet: AIOptions);
     get options(): AIOptions | undefined;

package/dist/src/types/chrome-adapter.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { InferenceMode } from './enums';
 import { CountTokensRequest, GenerateContentRequest } from './requests';
 /**
  * Defines an inference "backend" that uses Chrome's on-device model,
@@ -25,6 +26,10 @@ import { CountTokensRequest, GenerateContentRequest } from './requests';
  * @beta
  */
 export interface ChromeAdapter {
+    /**
+     * @internal
+     */
+    mode: InferenceMode;
     /**
      * Checks if the on-device model is capable of handling a given
      * request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/ai",
-  "version": "2.5.0",
+  "version": "2.6.0-20251112180857",
   "description": "The Firebase AI SDK",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "engines": {