@firebase/ai 2.7.0-canary.c4a3a5643 → 2.7.0-canary.f9254b6d2

package/dist/ai-public.d.ts

@@ -165,6 +165,7 @@ declare interface ApiSettings {
     backend: Backend;
     getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
     getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
 }
 
 /**
@@ -409,7 +410,7 @@ export declare interface CitationMetadata {
 /**
  * The results of code execution run by the model.
  *
- * @beta
+ * @public
  */
 export declare interface CodeExecutionResult {
     /**
@@ -426,7 +427,7 @@ export declare interface CodeExecutionResult {
 /**
  * Represents the code execution result from the model.
  *
- * @beta
+ * @public
  */
 export declare interface CodeExecutionResultPart {
     text?: never;
@@ -599,7 +600,7 @@ export declare interface ErrorDetails {
 /**
  * An interface for executable code returned by the model.
  *
- * @beta
+ * @public
  */
 export declare interface ExecutableCode {
     /**
@@ -615,7 +616,7 @@ export declare interface ExecutableCode {
 /**
  * Represents the code that is executed by the model.
  *
- * @beta
+ * @public
  */
 export declare interface ExecutableCodePart {
     text?: never;
@@ -1923,7 +1924,7 @@ export declare class IntegerSchema extends Schema {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export declare const Language: {
     UNSPECIFIED: string;
@@ -1933,7 +1934,7 @@ export declare const Language: {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export declare type Language = (typeof Language)[keyof typeof Language];
 
@@ -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.
@@ -2440,7 +2455,7 @@ export declare interface OnDeviceParams {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export declare const Outcome: {
     UNSPECIFIED: string;
@@ -2452,7 +2467,7 @@ export declare const Outcome: {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
 
@@ -3208,7 +3223,7 @@ export declare interface URLContext {
 /**
  * Metadata related to {@link URLContextTool}.
  *
- * @beta
+ * @public
  */
 export declare interface URLContextMetadata {
     /**
@@ -3234,7 +3249,7 @@ export declare interface URLContextTool {
 /**
  * Metadata for a single URL retrieved by the {@link URLContextTool} tool.
  *
- * @beta
+ * @public
  */
 export declare interface URLMetadata {
     /**
@@ -3262,7 +3277,7 @@ export declare interface URLMetadata {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export declare const URLRetrievalStatus: {
     /**
@@ -3302,7 +3317,7 @@ export declare const URLRetrievalStatus: {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export declare type URLRetrievalStatus = (typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];
 
@@ -3329,6 +3344,18 @@ export declare 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[];
 }
 
 /**

package/dist/ai.d.ts

@@ -202,6 +202,7 @@ declare interface ApiSettings {
     backend: Backend;
     getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
     getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+    inferenceMode?: InferenceMode;
 }
 
 /**
@@ -461,7 +462,7 @@ export declare interface CitationMetadata {
 /**
  * The results of code execution run by the model.
  *
- * @beta
+ * @public
  */
 export declare interface CodeExecutionResult {
     /**
@@ -478,7 +479,7 @@ export declare interface CodeExecutionResult {
 /**
  * Represents the code execution result from the model.
  *
- * @beta
+ * @public
  */
 export declare interface CodeExecutionResultPart {
     text?: never;
@@ -654,7 +655,7 @@ export declare interface ErrorDetails {
 /**
  * An interface for executable code returned by the model.
  *
- * @beta
+ * @public
  */
 export declare interface ExecutableCode {
     /**
@@ -670,7 +671,7 @@ export declare interface ExecutableCode {
 /**
  * Represents the code that is executed by the model.
  *
- * @beta
+ * @public
  */
 export declare interface ExecutableCodePart {
     text?: never;
@@ -2053,7 +2054,7 @@ export declare class IntegerSchema extends Schema {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export declare const Language: {
     UNSPECIFIED: string;
@@ -2063,7 +2064,7 @@ export declare const Language: {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 export declare type Language = (typeof Language)[keyof typeof Language];
 
@@ -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.
@@ -2586,7 +2601,7 @@ export declare interface OnDeviceParams {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export declare const Outcome: {
     UNSPECIFIED: string;
@@ -2598,7 +2613,7 @@ export declare const Outcome: {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
 
@@ -3371,7 +3386,7 @@ export declare interface URLContext {
 /**
  * Metadata related to {@link URLContextTool}.
  *
- * @beta
+ * @public
  */
 export declare interface URLContextMetadata {
     /**
@@ -3397,7 +3412,7 @@ export declare interface URLContextTool {
 /**
  * Metadata for a single URL retrieved by the {@link URLContextTool} tool.
  *
- * @beta
+ * @public
  */
 export declare interface URLMetadata {
     /**
@@ -3425,7 +3440,7 @@ export declare interface URLMetadata {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export declare const URLRetrievalStatus: {
     /**
@@ -3465,7 +3480,7 @@ export declare const URLRetrievalStatus: {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 export declare type URLRetrievalStatus = (typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];
 
@@ -3492,6 +3507,18 @@ export declare 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[];
 }
 
 /**

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.c4a3a5643";
+var version = "2.7.0-canary.f9254b6d2";
 
 /**
  * @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.
@@ -391,7 +392,7 @@ const InferenceSource = {
 /**
  * Represents the result of the code execution.
  *
- * @beta
+ * @public
  */
 const Outcome = {
     UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
@@ -402,7 +403,7 @@ const Outcome = {
 /**
  * The programming language of the code.
  *
- * @beta
+ * @public
  */
 const Language = {
     UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
@@ -453,7 +454,7 @@ const ThinkingLevel = {
  * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
  * <br/>
  *
- * @beta
+ * @public
  */
 const URLRetrievalStatus = {
     /**
@@ -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.