@firebase/ai 2.7.0 → 2.8.0-20260203132428

package/dist/esm/src/constants.d.ts

@@ -21,6 +21,7 @@ export declare const STAGING_URL = "https://staging-firebasevertexai.sandbox.goo
 export declare const DEFAULT_API_VERSION = "v1beta";
 export declare const PACKAGE_VERSION: string;
 export declare const LANGUAGE_TAG = "gl-js";
+export declare const HYBRID_TAG = "hybrid";
 export declare const DEFAULT_FETCH_TIMEOUT_MS: number;
 /**
  * Defines the name of the default in-cloud model to use for hybrid inference.

package/dist/esm/src/methods/live-session.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { FunctionResponse, GenerativeContentBlob, LiveServerContent, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
+import { FunctionResponse, GenerativeContentBlob, LiveServerContent, LiveServerGoingAwayNotice, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
 import { WebSocketHandler } from '../websocket';
 /**
  * Represents an active, real-time, bidirectional conversation with the model.
@@ -121,7 +121,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/src/types/content.d.ts

@@ -138,7 +138,7 @@ export interface FileDataPart {
 /**
  * Represents the code that is executed by the model.
  *
- * @beta
+ * @public
  */
 export interface ExecutableCodePart {
     text?: never;
@@ -157,7 +157,7 @@ export interface ExecutableCodePart {
 /**
  * Represents the code execution result from the model.
  *
- * @beta
+ * @public
  */
 export interface CodeExecutionResultPart {
     text?: never;
@@ -176,7 +176,7 @@ export interface CodeExecutionResultPart {
 /**
  * An interface for executable code returned by the model.
  *
- * @beta
+ * @public
  */
 export interface ExecutableCode {
     /**
@@ -191,7 +191,7 @@ export interface ExecutableCode {
 /**
  * The results of code execution run by the model.
  *
- * @beta
+ * @public
  */
 export interface CodeExecutionResult {
     /**

package/dist/esm/src/types/enums.d.ts

@@ -367,7 +367,7 @@ export type InferenceSource = (typeof InferenceSource)[keyof typeof InferenceSou
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export declare const Outcome: {
     UNSPECIFIED: string;
@@ -378,13 +378,13 @@ export declare const Outcome: {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export type Outcome = (typeof Outcome)[keyof typeof Outcome];
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export declare const Language: {
     UNSPECIFIED: string;
@@ -393,7 +393,7 @@ export declare const Language: {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export type Language = (typeof Language)[keyof typeof Language];
 /**

package/dist/esm/src/types/internal.d.ts

@@ -17,6 +17,7 @@
 import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
 import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { Backend } from '../backend';
+import { InferenceMode } from './enums';
 export * from './imagen/internal';
 export interface ApiSettings {
     apiKey: string;
@@ -30,4 +31,5 @@ export interface ApiSettings {
     backend: Backend;
     getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
     getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
 }

package/dist/esm/src/types/responses.d.ts

@@ -118,6 +118,18 @@ export interface UsageMetadata {
      * A list of tokens used by tools, broken down by modality.
      */
     toolUsePromptTokensDetails?: ModalityTokenCount[];
+    /**
+     * The number of tokens in the prompt that were served from the cache.
+     * If implicit caching is not active or no content was cached,
+     * this will be 0.
+     */
+    cachedContentTokenCount?: number;
+    /**
+     * Detailed breakdown of the cached tokens by modality (for example, text or
+     * image). This list provides granular insight into which parts of
+     * the content were cached.
+     */
+    cacheTokensDetails?: ModalityTokenCount[];
 }
 /**
  * Represents token counting info for a single modality.
@@ -341,7 +353,7 @@ export interface Segment {
 /**
  * Metadata related to {@link URLContextTool}.
  *
- * @beta
+ * @public
  */
 export interface URLContextMetadata {
     /**
@@ -352,7 +364,7 @@ export interface URLContextMetadata {
 /**
  * Metadata for a single URL retrieved by the {@link URLContextTool} tool.
  *
- * @beta
+ * @public
  */
 export interface URLMetadata {
     /**
@@ -379,7 +391,7 @@ export interface URLMetadata {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export declare const URLRetrievalStatus: {
     /**
@@ -418,7 +430,7 @@ export declare const URLRetrievalStatus: {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export type URLRetrievalStatus = (typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];
 /**
@@ -562,6 +574,18 @@ export interface LiveServerToolCallCancellation {
      */
     functionIds: string[];
 }
+/**
+ * Notification that the server will not be able to service the client soon.
+ *
+ * @beta
+ */
+export interface LiveServerGoingAwayNotice {
+    type: 'goingAwayNotice';
+    /**
+     * The remaining time (in seconds) before the connection will be terminated.
+     */
+    timeLeft: number;
+}
 /**
  * The types of responses that can be returned by {@link LiveSession.receive}.
  *
@@ -571,6 +595,7 @@ export declare const LiveResponseType: {
     SERVER_CONTENT: string;
     TOOL_CALL: string;
     TOOL_CALL_CANCELLATION: string;
+    GOING_AWAY_NOTICE: string;
 };
 /**
  * The types of responses that can be returned by {@link LiveSession.receive}.

package/dist/index.cjs.js

@@ -8,7 +8,7 @@ var util = require('@firebase/util');
 var logger$1 = require('@firebase/logger');
 
 var name = "@firebase/ai";
-var version = "2.7.0";
+var version = "2.8.0-20260203132428";
 
 /**
  * @license
@@ -32,6 +32,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.
@@ -395,7 +396,7 @@ const InferenceSource = {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 const Outcome = {
     UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
@@ -406,7 +407,7 @@ const Outcome = {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 const Language = {
     UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
@@ -457,7 +458,7 @@ const ThinkingLevel = {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 const URLRetrievalStatus = {
     /**
@@ -489,7 +490,8 @@ const URLRetrievalStatus = {
 const LiveResponseType = {
     SERVER_CONTENT: 'serverContent',
     TOOL_CALL: 'toolCall',
-    TOOL_CALL_CANCELLATION: 'toolCallCancellation'
+    TOOL_CALL_CANCELLATION: 'toolCallCancellation',
+    GOING_AWAY_NOTICE: 'goingAwayNotice'
 };
 
 /**
@@ -1516,16 +1518,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);
@@ -3142,6 +3153,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)}`);
                 }
@@ -3220,6 +3238,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
@@ -4467,7 +4497,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.