@firebase/ai 2.7.0-canary.65a553baf → 2.7.0-canary.8123231a1

package/dist/ai-public.d.ts

@@ -165,6 +165,7 @@ declare interface ApiSettings {
     backend: Backend;
     getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
     getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
 }
 
 /**
@@ -2124,6 +2125,7 @@ export declare const LiveResponseType: {
     SERVER_CONTENT: string;
     TOOL_CALL: string;
     TOOL_CALL_CANCELLATION: string;
+    GOING_AWAY_NOTICE: string;
 };
 
 /**
@@ -2166,6 +2168,19 @@ export declare interface LiveServerContent {
     outputTranscription?: Transcription;
 }
 
+/**
+ * Notification that the server will not be able to service the client soon.
+ *
+ * @beta
+ */
+export declare interface LiveServerGoingAwayNotice {
+    type: 'goingAwayNotice';
+    /**
+     * The remaining time (in seconds) before the connection will be terminated.
+     */
+    timeLeft: number;
+}
+
 /**
  * A request from the model for the client to execute one or more functions.
  *
@@ -2294,7 +2309,7 @@ export declare class LiveSession {
      *
      * @beta
      */
-    receive(): AsyncGenerator<LiveServerContent | LiveServerToolCall | LiveServerToolCallCancellation>;
+    receive(): AsyncGenerator<LiveServerContent | LiveServerToolCall | LiveServerToolCallCancellation | LiveServerGoingAwayNotice>;
     /**
      * Closes this session.
      * All methods on this session will throw an error once this resolves.

package/dist/ai.d.ts

@@ -202,6 +202,7 @@ declare interface ApiSettings {
     backend: Backend;
     getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
     getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
 }
 
 /**
@@ -2264,6 +2265,7 @@ export declare const LiveResponseType: {
     SERVER_CONTENT: string;
     TOOL_CALL: string;
     TOOL_CALL_CANCELLATION: string;
+    GOING_AWAY_NOTICE: string;
 };
 
 /**
@@ -2306,6 +2308,19 @@ export declare interface LiveServerContent {
     outputTranscription?: Transcription;
 }
 
+/**
+ * Notification that the server will not be able to service the client soon.
+ *
+ * @beta
+ */
+export declare interface LiveServerGoingAwayNotice {
+    type: 'goingAwayNotice';
+    /**
+     * The remaining time (in seconds) before the connection will be terminated.
+     */
+    timeLeft: number;
+}
+
 /**
  * A request from the model for the client to execute one or more functions.
  *
@@ -2437,7 +2452,7 @@ export declare class LiveSession {
      *
      * @beta
      */
-    receive(): AsyncGenerator<LiveServerContent | LiveServerToolCall | LiveServerToolCallCancellation>;
+    receive(): AsyncGenerator<LiveServerContent | LiveServerToolCall | LiveServerToolCallCancellation | LiveServerGoingAwayNotice>;
     /**
      * Closes this session.
      * All methods on this session will throw an error once this resolves.

package/dist/esm/index.esm.js

@@ -4,7 +4,7 @@ import { FirebaseError, Deferred, getModularInstance } from '@firebase/util';
 import { Logger } from '@firebase/logger';
 
 var name = "@firebase/ai";
-var version = "2.7.0-canary.65a553baf";
+var version = "2.7.0-canary.8123231a1";
 
 /**
  * @license
@@ -28,6 +28,7 @@ const DEFAULT_DOMAIN = 'firebasevertexai.googleapis.com';
 const DEFAULT_API_VERSION = 'v1beta';
 const PACKAGE_VERSION = version;
 const LANGUAGE_TAG = 'gl-js';
+const HYBRID_TAG = 'hybrid';
 const DEFAULT_FETCH_TIMEOUT_MS = 180 * 1000;
 /**
  * Defines the name of the default in-cloud model to use for hybrid inference.
@@ -485,7 +486,8 @@ const URLRetrievalStatus = {
 const LiveResponseType = {
     SERVER_CONTENT: 'serverContent',
     TOOL_CALL: 'toolCall',
-    TOOL_CALL_CANCELLATION: 'toolCallCancellation'
+    TOOL_CALL_CANCELLATION: 'toolCallCancellation',
+    GOING_AWAY_NOTICE: 'goingAwayNotice'
 };
 
 /**
@@ -1512,16 +1514,25 @@ class WebSocketUrl {
 /**
  * Log language and "fire/version" to x-goog-api-client
  */
-function getClientHeaders() {
+function getClientHeaders(url) {
     const loggingTags = [];
     loggingTags.push(`${LANGUAGE_TAG}/${PACKAGE_VERSION}`);
     loggingTags.push(`fire/${PACKAGE_VERSION}`);
+    /**
+     * No call would be made if ONLY_ON_DEVICE.
+     * ONLY_IN_CLOUD does not indicate an intention to use hybrid.
+     */
+    if (url.params.apiSettings.inferenceMode === InferenceMode.PREFER_ON_DEVICE ||
+        url.params.apiSettings.inferenceMode === InferenceMode.PREFER_IN_CLOUD) {
+        // No version
+        loggingTags.push(HYBRID_TAG);
+    }
     return loggingTags.join(' ');
 }
 async function getHeaders(url) {
     const headers = new Headers();
     headers.append('Content-Type', 'application/json');
-    headers.append('x-goog-api-client', getClientHeaders());
+    headers.append('x-goog-api-client', getClientHeaders(url));
     headers.append('x-goog-api-key', url.params.apiSettings.apiKey);
     if (url.params.apiSettings.automaticDataCollectionEnabled) {
         headers.append('X-Firebase-Appid', url.params.apiSettings.appId);
@@ -3138,6 +3149,13 @@ class LiveSession {
                         ...message.toolCallCancellation
                     };
                 }
+                else if ('goAway' in message) {
+                    const notice = message.goAway;
+                    yield {
+                        type: LiveResponseType.GOING_AWAY_NOTICE,
+                        timeLeft: parseDuration(notice.timeLeft)
+                    };
+                }
                 else {
                     logger.warn(`Received an unknown message type from the server: ${JSON.stringify(message)}`);
                 }
@@ -3216,6 +3234,18 @@ class LiveSession {
         }
     }
 }
+/**
+ * Parses a duration string (e.g. "3.000000001s") into a number of seconds.
+ *
+ * @param duration - The duration string to parse.
+ * @returns The duration in seconds.
+ */
+function parseDuration(duration) {
+    if (!duration || !duration.endsWith('s')) {
+        return 0;
+    }
+    return Number(duration.slice(0, -1)); // slice removes the trailing 's'.
+}
 
 /**
  * @license
@@ -4463,7 +4493,9 @@ function getGenerativeModel(ai, modelParams, requestOptions) {
      * chromeAdapterFactory() method.
      */
     const chromeAdapter = ai.chromeAdapterFactory?.(hybridParams.mode, typeof window === 'undefined' ? undefined : window, hybridParams.onDeviceParams);
-    return new GenerativeModel(ai, inCloudParams, requestOptions, chromeAdapter);
+    const generativeModel = new GenerativeModel(ai, inCloudParams, requestOptions, chromeAdapter);
+    generativeModel._apiSettings.inferenceMode = hybridParams.mode;
+    return generativeModel;
 }
 /**
  * Returns an {@link ImagenModel} class with methods for using Imagen.