@firebase/ai 2.2.0 → 2.2.1-canary.06ab5c4f9

package/dist/ai-public.d.ts

@@ -4,17 +4,10 @@
  * @packageDocumentation
  */
 
-import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
-import { ComponentContainer } from '@firebase/component';
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
-import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
-import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { FirebaseError } from '@firebase/util';
-import { InstanceFactoryOptions } from '@firebase/component';
-import { Provider } from '@firebase/component';
 
 /**
  * An instance of the Firebase AI SDK.
@@ -147,20 +140,6 @@ export declare interface AIOptions {
     useLimitedUseAppCheckTokens?: boolean;
 }
 
-declare class AIService implements AI, _FirebaseService {
-    app: FirebaseApp;
-    backend: Backend;
-    chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapterImpl | 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);
-    _delete(): Promise<void>;
-    set options(optionsToSet: AIOptions);
-    get options(): AIOptions | undefined;
-}
-
 /**
  * Schema class representing a value that can conform to any of the provided sub-schemas. This is
  * useful when a field can accept multiple distinct types or structures.
@@ -213,8 +192,6 @@ export declare interface AudioConversationController {
     stop: () => Promise<void>;
 }
 
-/* Excluded from this release type: Availability */
-
 /**
  * Abstract base class representing the configuration for an AI service backend.
  * This class should not be instantiated directly. Use its subclasses; {@link GoogleAIBackend} for
@@ -385,108 +362,6 @@ export declare interface ChromeAdapter {
     /* Excluded from this release type: countTokens */
 }
 
-/**
- * Defines an inference "backend" that uses Chrome's on-device model,
- * and encapsulates logic for detecting when on-device inference is
- * possible.
- */
-declare class ChromeAdapterImpl implements ChromeAdapter {
-    languageModelProvider: LanguageModel;
-    mode: InferenceMode;
-    onDeviceParams: OnDeviceParams;
-    static SUPPORTED_MIME_TYPES: string[];
-    private isDownloading;
-    private downloadPromise;
-    private oldSession;
-    constructor(languageModelProvider: LanguageModel, mode: InferenceMode, onDeviceParams?: OnDeviceParams);
-    /**
-     * Checks if a given request can be made on-device.
-     *
-     * Encapsulates a few concerns:
-     *   the mode
-     *   API existence
-     *   prompt formatting
-     *   model availability, including triggering download if necessary
-     *
-     *
-     * Pros: callers needn't be concerned with details of on-device availability.</p>
-     * Cons: this method spans a few concerns and splits request validation from usage.
-     * If instance variables weren't already part of the API, we could consider a better
-     * separation of concerns.
-     */
-    isAvailable(request: GenerateContentRequest): Promise<boolean>;
-    /**
-     * Generates content on device.
-     *
-     * @remarks
-     * This is comparable to {@link GenerativeModel.generateContent} for generating content in
-     * Cloud.
-     * @param request - a standard Firebase AI {@link GenerateContentRequest}
-     * @returns {@link Response}, so we can reuse common response formatting.
-     */
-    generateContent(request: GenerateContentRequest): Promise<Response>;
-    /**
-     * Generates content stream on device.
-     *
-     * @remarks
-     * This is comparable to {@link GenerativeModel.generateContentStream} for generating content in
-     * Cloud.
-     * @param request - a standard Firebase AI {@link GenerateContentRequest}
-     * @returns {@link Response}, so we can reuse common response formatting.
-     */
-    generateContentStream(request: GenerateContentRequest): Promise<Response>;
-    countTokens(_request: CountTokensRequest): Promise<Response>;
-    /**
-     * Asserts inference for the given request can be performed by an on-device model.
-     */
-    private static isOnDeviceRequest;
-    /**
-     * Encapsulates logic to get availability and download a model if one is downloadable.
-     */
-    private downloadIfAvailable;
-    /**
-     * Triggers out-of-band download of an on-device model.
-     *
-     * Chrome only downloads models as needed. Chrome knows a model is needed when code calls
-     * LanguageModel.create.
-     *
-     * Since Chrome manages the download, the SDK can only avoid redundant download requests by
-     * tracking if a download has previously been requested.
-     */
-    private download;
-    /**
-     * Converts Firebase AI {@link Content} object to a Chrome {@link LanguageModelMessage} object.
-     */
-    private static toLanguageModelMessage;
-    /**
-     * Converts a Firebase AI Part object to a Chrome LanguageModelMessageContent object.
-     */
-    private static toLanguageModelMessageContent;
-    /**
-     * Converts a Firebase AI {@link Role} string to a {@link LanguageModelMessageRole} string.
-     */
-    private static toLanguageModelMessageRole;
-    /**
-     * Abstracts Chrome session creation.
-     *
-     * Chrome uses a multi-turn session for all inference. Firebase AI uses single-turn for all
-     * inference. To map the Firebase AI API to Chrome's API, the SDK creates a new session for all
-     * inference.
-     *
-     * Chrome will remove a model from memory if it's no longer in use, so this method ensures a
-     * new session is created before an old session is destroyed.
-     */
-    private createSession;
-    /**
-     * Formats string returned by Chrome as a {@link Response} returned by Firebase AI.
-     */
-    private static toResponse;
-    /**
-     * Formats string stream returned by Chrome as SSE returned by Firebase AI.
-     */
-    private static toStreamResponse;
-}
-
 /**
  * A single citation.
  * @public
@@ -655,8 +530,6 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
-export declare function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;
-
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -729,8 +602,6 @@ export declare const FinishReason: {
  */
 export declare type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
 
-/* Excluded from this release type: _FirebaseService */
-
 /**
  * A predicted {@link FunctionCall} returned from the model
  * that contains a string representing the {@link FunctionDeclaration.name}
@@ -1846,17 +1717,36 @@ export declare interface ImagenSafetySettings {
 /**
  * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
+ *
+ * @remarks
+ * <b>PREFER_ON_DEVICE:</b> Attempt to make inference calls using an
+ * on-device model. If on-device inference is not available, the SDK
+ * will fall back to using a cloud-hosted model.
+ * <br/>
+ * <b>ONLY_ON_DEVICE:</b> Only attempt to make inference calls using an
+ * on-device model. The SDK will not fall back to a cloud-hosted model.
+ * If on-device inference is not available, inference methods will throw.
+ * <br/>
+ * <b>ONLY_IN_CLOUD:</b> Only attempt to make inference calls using a
+ * cloud-hosted model. The SDK will not fall back to an on-device model.
+ * <br/>
+ * <b>PREFER_IN_CLOUD:</b> Attempt to make inference calls to a
+ * cloud-hosted model. If not available, the SDK will fall back to an
+ * on-device model.
+ *
  * @public
  */
 export declare const InferenceMode: {
     readonly PREFER_ON_DEVICE: "prefer_on_device";
     readonly ONLY_ON_DEVICE: "only_on_device";
     readonly ONLY_IN_CLOUD: "only_in_cloud";
+    readonly PREFER_IN_CLOUD: "prefer_in_cloud";
 };
 
 /**
  * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
+ *
  * @public
  */
 export declare type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
@@ -1886,8 +1776,6 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
-/* Excluded from this release type: LanguageModel */
-
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -1959,13 +1847,6 @@ export declare type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
  */
 export declare type LanguageModelMessageType = 'text' | 'image' | 'audio';
 
-/**
- * <b>(EXPERIMENTAL)</b>
- * An on-device language model prompt.
- * @public
- */
-declare type LanguageModelPrompt = LanguageModelMessage[];
-
 /**
  * <b>(EXPERIMENTAL)</b>
  * Options for an on-device language model prompt.

package/dist/ai.d.ts

@@ -4,18 +4,10 @@
  * @packageDocumentation
  */
 
-import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
-import { ComponentContainer } from '@firebase/component';
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
-import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
-import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { FirebaseError } from '@firebase/util';
-import { _FirebaseService } from '@firebase/app';
-import { InstanceFactoryOptions } from '@firebase/component';
-import { Provider } from '@firebase/component';
 
 /**
  * An instance of the Firebase AI SDK.
@@ -182,20 +174,6 @@ export declare interface AIOptions {
     useLimitedUseAppCheckTokens?: boolean;
 }
 
-declare class AIService implements AI, _FirebaseService {
-    app: FirebaseApp;
-    backend: Backend;
-    chromeAdapterFactory?: ((mode: InferenceMode, window?: Window, params?: OnDeviceParams) => ChromeAdapterImpl | 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);
-    _delete(): Promise<void>;
-    set options(optionsToSet: AIOptions);
-    get options(): AIOptions | undefined;
-}
-
 /**
  * Schema class representing a value that can conform to any of the provided sub-schemas. This is
  * useful when a field can accept multiple distinct types or structures.
@@ -254,16 +232,6 @@ export declare interface AudioConversationController {
     stop: () => Promise<void>;
 }
 
-/**
- * @internal
- */
-declare enum Availability {
-    'UNAVAILABLE' = "unavailable",
-    'DOWNLOADABLE' = "downloadable",
-    'DOWNLOADING' = "downloading",
-    'AVAILABLE' = "available"
-}
-
 /**
  * Abstract base class representing the configuration for an AI service backend.
  * This class should not be instantiated directly. Use its subclasses; {@link GoogleAIBackend} for
@@ -437,108 +405,6 @@ export declare interface ChromeAdapter {
     countTokens(request: CountTokensRequest): Promise<Response>;
 }
 
-/**
- * Defines an inference "backend" that uses Chrome's on-device model,
- * and encapsulates logic for detecting when on-device inference is
- * possible.
- */
-declare class ChromeAdapterImpl implements ChromeAdapter {
-    languageModelProvider: LanguageModel;
-    mode: InferenceMode;
-    onDeviceParams: OnDeviceParams;
-    static SUPPORTED_MIME_TYPES: string[];
-    private isDownloading;
-    private downloadPromise;
-    private oldSession;
-    constructor(languageModelProvider: LanguageModel, mode: InferenceMode, onDeviceParams?: OnDeviceParams);
-    /**
-     * Checks if a given request can be made on-device.
-     *
-     * Encapsulates a few concerns:
-     *   the mode
-     *   API existence
-     *   prompt formatting
-     *   model availability, including triggering download if necessary
-     *
-     *
-     * Pros: callers needn't be concerned with details of on-device availability.</p>
-     * Cons: this method spans a few concerns and splits request validation from usage.
-     * If instance variables weren't already part of the API, we could consider a better
-     * separation of concerns.
-     */
-    isAvailable(request: GenerateContentRequest): Promise<boolean>;
-    /**
-     * Generates content on device.
-     *
-     * @remarks
-     * This is comparable to {@link GenerativeModel.generateContent} for generating content in
-     * Cloud.
-     * @param request - a standard Firebase AI {@link GenerateContentRequest}
-     * @returns {@link Response}, so we can reuse common response formatting.
-     */
-    generateContent(request: GenerateContentRequest): Promise<Response>;
-    /**
-     * Generates content stream on device.
-     *
-     * @remarks
-     * This is comparable to {@link GenerativeModel.generateContentStream} for generating content in
-     * Cloud.
-     * @param request - a standard Firebase AI {@link GenerateContentRequest}
-     * @returns {@link Response}, so we can reuse common response formatting.
-     */
-    generateContentStream(request: GenerateContentRequest): Promise<Response>;
-    countTokens(_request: CountTokensRequest): Promise<Response>;
-    /**
-     * Asserts inference for the given request can be performed by an on-device model.
-     */
-    private static isOnDeviceRequest;
-    /**
-     * Encapsulates logic to get availability and download a model if one is downloadable.
-     */
-    private downloadIfAvailable;
-    /**
-     * Triggers out-of-band download of an on-device model.
-     *
-     * Chrome only downloads models as needed. Chrome knows a model is needed when code calls
-     * LanguageModel.create.
-     *
-     * Since Chrome manages the download, the SDK can only avoid redundant download requests by
-     * tracking if a download has previously been requested.
-     */
-    private download;
-    /**
-     * Converts Firebase AI {@link Content} object to a Chrome {@link LanguageModelMessage} object.
-     */
-    private static toLanguageModelMessage;
-    /**
-     * Converts a Firebase AI Part object to a Chrome LanguageModelMessageContent object.
-     */
-    private static toLanguageModelMessageContent;
-    /**
-     * Converts a Firebase AI {@link Role} string to a {@link LanguageModelMessageRole} string.
-     */
-    private static toLanguageModelMessageRole;
-    /**
-     * Abstracts Chrome session creation.
-     *
-     * Chrome uses a multi-turn session for all inference. Firebase AI uses single-turn for all
-     * inference. To map the Firebase AI API to Chrome's API, the SDK creates a new session for all
-     * inference.
-     *
-     * Chrome will remove a model from memory if it's no longer in use, so this method ensures a
-     * new session is created before an old session is destroyed.
-     */
-    private createSession;
-    /**
-     * Formats string returned by Chrome as a {@link Response} returned by Firebase AI.
-     */
-    private static toResponse;
-    /**
-     * Formats string stream returned by Chrome as SSE returned by Firebase AI.
-     */
-    private static toStreamResponse;
-}
-
 /**
  * A single citation.
  * @public
@@ -707,8 +573,6 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
-export declare function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;
-
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -1958,17 +1822,36 @@ export declare interface ImagenSafetySettings {
 /**
  * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
+ *
+ * @remarks
+ * <b>PREFER_ON_DEVICE:</b> Attempt to make inference calls using an
+ * on-device model. If on-device inference is not available, the SDK
+ * will fall back to using a cloud-hosted model.
+ * <br/>
+ * <b>ONLY_ON_DEVICE:</b> Only attempt to make inference calls using an
+ * on-device model. The SDK will not fall back to a cloud-hosted model.
+ * If on-device inference is not available, inference methods will throw.
+ * <br/>
+ * <b>ONLY_IN_CLOUD:</b> Only attempt to make inference calls using a
+ * cloud-hosted model. The SDK will not fall back to an on-device model.
+ * <br/>
+ * <b>PREFER_IN_CLOUD:</b> Attempt to make inference calls to a
+ * cloud-hosted model. If not available, the SDK will fall back to an
+ * on-device model.
+ *
  * @public
  */
 export declare const InferenceMode: {
     readonly PREFER_ON_DEVICE: "prefer_on_device";
     readonly ONLY_ON_DEVICE: "only_on_device";
     readonly ONLY_IN_CLOUD: "only_in_cloud";
+    readonly PREFER_IN_CLOUD: "prefer_in_cloud";
 };
 
 /**
  * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
+ *
  * @public
  */
 export declare type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
@@ -2001,38 +1884,6 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
-/**
- * @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.
- */
-/**
- * The subset of the Prompt API
- * (see {@link https://github.com/webmachinelearning/prompt-api#full-api-surface-in-web-idl }
- * required for hybrid functionality.
- *
- * @internal
- */
-declare interface LanguageModel extends EventTarget {
-    create(options?: LanguageModelCreateOptions): Promise<LanguageModel>;
-    availability(options?: LanguageModelCreateCoreOptions): Promise<Availability>;
-    prompt(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): Promise<string>;
-    promptStreaming(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): ReadableStream;
-    measureInputUsage(input: LanguageModelPrompt, options?: LanguageModelPromptOptions): Promise<number>;
-    destroy(): undefined;
-}
-
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -2104,13 +1955,6 @@ export declare type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
  */
 export declare type LanguageModelMessageType = 'text' | 'image' | 'audio';
 
-/**
- * <b>(EXPERIMENTAL)</b>
- * An on-device language model prompt.
- * @public
- */
-declare type LanguageModelPrompt = LanguageModelMessage[];
-
 /**
  * <b>(EXPERIMENTAL)</b>
  * Options for an on-device language model prompt.