@firebase/ai 2.12.0 → 2.13.0-20260526192810

package/dist/ai-public.d.ts

@@ -363,7 +363,7 @@ export declare abstract class ChatSessionBase<ParamsType extends StartChatParams
  *
  * These methods should not be called directly by the user.
  *
- * @beta
+ * @public
  */
 export declare interface ChromeAdapter {
     /* Excluded from this release type: mode */
@@ -612,7 +612,7 @@ export declare interface EnhancedGenerateContentResponse extends GenerateContent
     /**
      * Indicates whether inference happened on-device or in-cloud.
      *
-     * @beta
+     * @public
      */
     inferenceSource?: InferenceSource;
 }
@@ -1090,6 +1090,35 @@ export declare class GenerativeModel extends AIModel {
     toolConfig?: ToolConfig;
     systemInstruction?: Content;
     constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions, chromeAdapter?: ChromeAdapter | undefined);
+    /**
+     * Initializes on-device models.
+     *
+     * @remarks
+     * This may trigger a download on first
+     * use. Wait for this promise to complete before calling inference
+     * methods if you want to ensure the device models are ready before
+     * any calls. Calling inference methods before the device is ready
+     * will result in a cloud fallback if `inferenceMode` is set to
+     * `PREFER_ON_DEVICE`, and an error if set to `ONLY_ON_DEVICE`.
+     *
+     * IMPORTANT: This call must be made on or after a user has interacted
+     * with the page (for example, through a button click or key press).
+     * If it is called without a user interaction, and it requires a download,
+     * this will cause an error.
+     *
+     * See the
+     * {@link https://developer.chrome.com/docs/ai/prompt-api#use_the_prompt_api | Prompt API docs }
+     * for more details on this requirement.
+     *
+     * @param onDownloadProgress A callback called repeatedly as the
+     * download progresses that provides a `progressValue` between 0
+     * and 1 representing how much of the download is complete. This
+     * will be ignored if `monitor` was populated in
+     * {@link LanguageModelCreateOptions}.
+     *
+     * @public
+     */
+    initializeDeviceModel(onDownloadProgress?: (progressValue: number) => void): Promise<void>;
     /**
      * Makes a single non-streaming call to the model
      * and returns an object containing a single {@link GenerateContentResponse}.
@@ -1561,7 +1590,7 @@ export declare type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeveri
 
 /**
  * Configures hybrid inference.
- * @beta
+ * @public
  */
 export declare interface HybridParams {
     /**
@@ -2173,7 +2202,7 @@ export declare interface ImagenSafetySettings {
  * cloud-hosted model. If not available, the SDK will fall back to an
  * on-device model.
  *
- * @beta
+ * @public
  */
 export declare const InferenceMode: {
     readonly PREFER_ON_DEVICE: "prefer_on_device";
@@ -2185,14 +2214,14 @@ export declare const InferenceMode: {
 /**
  * Determines whether inference happens on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
 
 /**
  * Indicates whether inference happened on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare const InferenceSource: {
     readonly ON_DEVICE: "on_device";
@@ -2202,7 +2231,7 @@ export declare const InferenceSource: {
 /**
  * Indicates whether inference happened on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare type InferenceSource = (typeof InferenceSource)[keyof typeof InferenceSource];
 
@@ -2252,7 +2281,7 @@ export declare type Language = (typeof Language)[keyof typeof Language];
 
 /**
  * Configures the creation of an on-device language model session.
- * @beta
+ * @public
  */
 export declare interface LanguageModelCreateCoreOptions {
     /**
@@ -2263,21 +2292,52 @@ export declare interface LanguageModelCreateCoreOptions {
      * @deprecated
      */
     temperature?: number;
+    /**
+     * Defaults to image input and English text input
+     * if not overriden.
+     */
     expectedInputs?: LanguageModelExpected[];
+    /**
+     * Defaults to English text output if not overriden.
+     */
+    expectedOutputs?: LanguageModelExpected[];
+    /**
+     * The native download monitor provided by the Chrome API.
+     * This provides direct access to the monitor object and is
+     * only needed for advanced cases. For
+     * a simpler download monitoring interface, provide an
+     * `onDownloadProgress` callback
+     * to {@link GenerativeModel.initializeDeviceModel} instead.
+     */
+    monitor?: (monitor: LanguageModelDownloadMonitor) => void;
 }
 
 /**
  * Configures the creation of an on-device language model session.
- * @beta
+ * @public
  */
 export declare interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
     signal?: AbortSignal;
     initialPrompts?: LanguageModelMessage[];
 }
 
+/**
+ * Interface representing the Chrome Prompt API's native
+ * download monitor object.
+ * @public
+ */
+export declare interface LanguageModelDownloadMonitor {
+    addEventListener: (eventType: 'downloadprogress', eventListener: (e: {
+        loaded: number;
+    }) => void) => void;
+    removeEventListener: (eventType: 'downloadprogress', eventListener: (e: {
+        loaded: number;
+    }) => void) => void;
+}
+
 /**
  * Options for the expected inputs for an on-device language model.
- * @beta
+ * @public
  */ export declare interface LanguageModelExpected {
     type: LanguageModelMessageType;
     languages?: string[];
@@ -2285,7 +2345,7 @@ export declare interface LanguageModelCreateOptions extends LanguageModelCreateC
 
 /**
  * An on-device language model message.
- * @beta
+ * @public
  */
 export declare interface LanguageModelMessage {
     role: LanguageModelMessageRole;
@@ -2294,7 +2354,7 @@ export declare interface LanguageModelMessage {
 
 /**
  * An on-device language model content object.
- * @beta
+ * @public
  */
 export declare interface LanguageModelMessageContent {
     type: LanguageModelMessageType;
@@ -2303,25 +2363,25 @@ export declare interface LanguageModelMessageContent {
 
 /**
  * Content formats that can be provided as on-device message content.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer | BufferSource | string;
 
 /**
  * Allowable roles for on-device language model usage.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
 
 /**
  * Allowable types for on-device language model messages.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageType = 'text' | 'image' | 'audio';
 
 /**
  * Options for an on-device language model prompt.
- * @beta
+ * @public
  */
 export declare interface LanguageModelPromptOptions {
     responseConstraint?: object;
@@ -2846,7 +2906,7 @@ export declare interface ObjectSchemaRequest extends SchemaRequest {
 /**
  * Encapsulates configuration for on-device inference.
  *
- * @beta
+ * @public
  */
 export declare interface OnDeviceParams {
     createOptions?: LanguageModelCreateOptions;

package/dist/ai.d.ts

@@ -468,7 +468,7 @@ export declare abstract class ChatSessionBase<ParamsType extends StartChatParams
  *
  * These methods should not be called directly by the user.
  *
- * @beta
+ * @public
  */
 export declare interface ChromeAdapter {
     /**
@@ -726,7 +726,7 @@ export declare interface EnhancedGenerateContentResponse extends GenerateContent
     /**
      * Indicates whether inference happened on-device or in-cloud.
      *
-     * @beta
+     * @public
      */
     inferenceSource?: InferenceSource;
 }
@@ -1216,6 +1216,35 @@ export declare class GenerativeModel extends AIModel {
     toolConfig?: ToolConfig;
     systemInstruction?: Content;
     constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions, chromeAdapter?: ChromeAdapter | undefined);
+    /**
+     * Initializes on-device models.
+     *
+     * @remarks
+     * This may trigger a download on first
+     * use. Wait for this promise to complete before calling inference
+     * methods if you want to ensure the device models are ready before
+     * any calls. Calling inference methods before the device is ready
+     * will result in a cloud fallback if `inferenceMode` is set to
+     * `PREFER_ON_DEVICE`, and an error if set to `ONLY_ON_DEVICE`.
+     *
+     * IMPORTANT: This call must be made on or after a user has interacted
+     * with the page (for example, through a button click or key press).
+     * If it is called without a user interaction, and it requires a download,
+     * this will cause an error.
+     *
+     * See the
+     * {@link https://developer.chrome.com/docs/ai/prompt-api#use_the_prompt_api | Prompt API docs }
+     * for more details on this requirement.
+     *
+     * @param onDownloadProgress A callback called repeatedly as the
+     * download progresses that provides a `progressValue` between 0
+     * and 1 representing how much of the download is complete. This
+     * will be ignored if `monitor` was populated in
+     * {@link LanguageModelCreateOptions}.
+     *
+     * @public
+     */
+    initializeDeviceModel(onDownloadProgress?: (progressValue: number) => void): Promise<void>;
     /**
      * Makes a single non-streaming call to the model
      * and returns an object containing a single {@link GenerateContentResponse}.
@@ -1728,7 +1757,7 @@ export declare type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeveri
 
 /**
  * Configures hybrid inference.
- * @beta
+ * @public
  */
 export declare interface HybridParams {
     /**
@@ -2359,7 +2388,7 @@ export declare interface ImagenSafetySettings {
  * cloud-hosted model. If not available, the SDK will fall back to an
  * on-device model.
  *
- * @beta
+ * @public
  */
 export declare const InferenceMode: {
     readonly PREFER_ON_DEVICE: "prefer_on_device";
@@ -2371,14 +2400,14 @@ export declare const InferenceMode: {
 /**
  * Determines whether inference happens on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
 
 /**
  * Indicates whether inference happened on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare const InferenceSource: {
     readonly ON_DEVICE: "on_device";
@@ -2388,7 +2417,7 @@ export declare const InferenceSource: {
 /**
  * Indicates whether inference happened on-device or in-cloud.
  *
- * @beta
+ * @public
  */
 export declare type InferenceSource = (typeof InferenceSource)[keyof typeof InferenceSource];
 
@@ -2441,7 +2470,7 @@ export declare type Language = (typeof Language)[keyof typeof Language];
 
 /**
  * Configures the creation of an on-device language model session.
- * @beta
+ * @public
  */
 export declare interface LanguageModelCreateCoreOptions {
     /**
@@ -2452,21 +2481,52 @@ export declare interface LanguageModelCreateCoreOptions {
      * @deprecated
      */
     temperature?: number;
+    /**
+     * Defaults to image input and English text input
+     * if not overriden.
+     */
     expectedInputs?: LanguageModelExpected[];
+    /**
+     * Defaults to English text output if not overriden.
+     */
+    expectedOutputs?: LanguageModelExpected[];
+    /**
+     * The native download monitor provided by the Chrome API.
+     * This provides direct access to the monitor object and is
+     * only needed for advanced cases. For
+     * a simpler download monitoring interface, provide an
+     * `onDownloadProgress` callback
+     * to {@link GenerativeModel.initializeDeviceModel} instead.
+     */
+    monitor?: (monitor: LanguageModelDownloadMonitor) => void;
 }
 
 /**
  * Configures the creation of an on-device language model session.
- * @beta
+ * @public
  */
 export declare interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
     signal?: AbortSignal;
     initialPrompts?: LanguageModelMessage[];
 }
 
+/**
+ * Interface representing the Chrome Prompt API's native
+ * download monitor object.
+ * @public
+ */
+export declare interface LanguageModelDownloadMonitor {
+    addEventListener: (eventType: 'downloadprogress', eventListener: (e: {
+        loaded: number;
+    }) => void) => void;
+    removeEventListener: (eventType: 'downloadprogress', eventListener: (e: {
+        loaded: number;
+    }) => void) => void;
+}
+
 /**
  * Options for the expected inputs for an on-device language model.
- * @beta
+ * @public
  */ export declare interface LanguageModelExpected {
     type: LanguageModelMessageType;
     languages?: string[];
@@ -2474,7 +2534,7 @@ export declare interface LanguageModelCreateOptions extends LanguageModelCreateC
 
 /**
  * An on-device language model message.
- * @beta
+ * @public
  */
 export declare interface LanguageModelMessage {
     role: LanguageModelMessageRole;
@@ -2483,7 +2543,7 @@ export declare interface LanguageModelMessage {
 
 /**
  * An on-device language model content object.
- * @beta
+ * @public
  */
 export declare interface LanguageModelMessageContent {
     type: LanguageModelMessageType;
@@ -2492,25 +2552,25 @@ export declare interface LanguageModelMessageContent {
 
 /**
  * Content formats that can be provided as on-device message content.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer | BufferSource | string;
 
 /**
  * Allowable roles for on-device language model usage.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
 
 /**
  * Allowable types for on-device language model messages.
- * @beta
+ * @public
  */
 export declare type LanguageModelMessageType = 'text' | 'image' | 'audio';
 
 /**
  * Options for an on-device language model prompt.
- * @beta
+ * @public
  */
 export declare interface LanguageModelPromptOptions {
     responseConstraint?: object;
@@ -3076,7 +3136,7 @@ export declare interface ObjectSchemaRequest extends SchemaRequest {
 /**
  * Encapsulates configuration for on-device inference.
  *
- * @beta
+ * @public
  */
 export declare interface OnDeviceParams {
     createOptions?: LanguageModelCreateOptions;