@firebase/ai 2.2.1-canary.55f3f83a7 → 2.2.1-canary.9b8ab02c5

package/dist/ai-public.d.ts

@@ -393,6 +393,53 @@ export declare interface CitationMetadata {
     citations: Citation[];
 }
 
+/**
+ * The results of code execution run by the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResult {
+    /**
+     * The result of the code execution.
+     */
+    outcome?: Outcome;
+    /**
+     * The output from the code execution, or an error message
+     * if it failed.
+     */
+    output?: string;
+}
+
+/**
+ * Represents the code execution result from the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResultPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: CodeExecutionResult;
+}
+
+/**
+ * A tool that enables the model to use code execution.
+ *
+ * @public
+ */
+export declare interface CodeExecutionTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     */
+    codeExecution: {};
+}
+
 /**
  * Content type for both prompts and response candidates.
  * @public
@@ -530,6 +577,39 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
+/**
+ * An interface for executable code returned by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCode {
+    /**
+     * The programming language of the code.
+     */
+    language?: Language;
+    /**
+     * The source code to be executed.
+     */
+    code?: string;
+}
+
+/**
+ * Represents the code that is executed by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCodePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /* Excluded from this release type: thoughtSignature */
+    executableCode?: ExecutableCode;
+    codeExecutionResult?: never;
+}
+
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -551,6 +631,8 @@ export declare interface FileDataPart {
     fileData: FileData;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -669,6 +751,8 @@ export declare interface FunctionCallPart {
     functionResponse?: never;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -753,6 +837,8 @@ export declare interface FunctionResponsePart {
     functionResponse: FunctionResponse;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1024,8 +1110,6 @@ export declare interface GoogleSearchTool {
     /**
      * Specifies the Google Search configuration.
      * Currently, this is an empty object, but it's reserved for future configuration options.
-     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
-     * reserved for future configuration options.
      *
      * When using this feature, you are required to comply with the "Grounding with Google Search"
      * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
@@ -1717,17 +1801,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];
@@ -1747,6 +1850,8 @@ export declare interface InlineDataPart {
     videoMetadata?: VideoMetadata;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1757,6 +1862,23 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare type Language = (typeof Language)[keyof typeof Language];
+
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -2177,12 +2299,31 @@ export declare interface OnDeviceParams {
     promptOptions?: LanguageModelPromptOptions;
 }
 
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare const Outcome: {
+    UNSPECIFIED: string;
+    OK: string;
+    FAILED: string;
+    DEADLINE_EXCEEDED: string;
+};
+
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
+
 /**
  * Content part - includes text, image/video, or function call/response
  * part types.
  * @public
  */
-export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
 
 /**
  * Possible roles.
@@ -2684,6 +2825,8 @@ export declare interface TextPart {
     functionResponse?: never;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -2724,7 +2867,7 @@ export declare interface ThinkingConfig {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.

package/dist/ai.d.ts

@@ -436,6 +436,56 @@ export declare interface CitationMetadata {
     citations: Citation[];
 }
 
+/**
+ * The results of code execution run by the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResult {
+    /**
+     * The result of the code execution.
+     */
+    outcome?: Outcome;
+    /**
+     * The output from the code execution, or an error message
+     * if it failed.
+     */
+    output?: string;
+}
+
+/**
+ * Represents the code execution result from the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResultPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: CodeExecutionResult;
+}
+
+/**
+ * A tool that enables the model to use code execution.
+ *
+ * @public
+ */
+export declare interface CodeExecutionTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     */
+    codeExecution: {};
+}
+
 /**
  * Content type for both prompts and response candidates.
  * @public
@@ -573,6 +623,42 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
+/**
+ * An interface for executable code returned by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCode {
+    /**
+     * The programming language of the code.
+     */
+    language?: Language;
+    /**
+     * The source code to be executed.
+     */
+    code?: string;
+}
+
+/**
+ * Represents the code that is executed by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCodePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: ExecutableCode;
+    codeExecutionResult?: never;
+}
+
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -597,6 +683,8 @@ export declare interface FileDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -718,6 +806,8 @@ export declare interface FunctionCallPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -805,6 +895,8 @@ export declare interface FunctionResponsePart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1110,8 +1202,6 @@ export declare interface GoogleSearchTool {
     /**
      * Specifies the Google Search configuration.
      * Currently, this is an empty object, but it's reserved for future configuration options.
-     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
-     * reserved for future configuration options.
      *
      * When using this feature, you are required to comply with the "Grounding with Google Search"
      * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
@@ -1822,17 +1912,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];
@@ -1855,6 +1964,8 @@ export declare interface InlineDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1865,6 +1976,23 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare type Language = (typeof Language)[keyof typeof Language];
+
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -2301,12 +2429,31 @@ export declare interface OnDeviceParams {
     promptOptions?: LanguageModelPromptOptions;
 }
 
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare const Outcome: {
+    UNSPECIFIED: string;
+    OK: string;
+    FAILED: string;
+    DEADLINE_EXCEEDED: string;
+};
+
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
+
 /**
  * Content part - includes text, image/video, or function call/response
  * part types.
  * @public
  */
-export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
 
 /**
  * Possible roles.
@@ -2819,6 +2966,8 @@ export declare interface TextPart {
      * @internal
      */
     thoughtSignature?: string;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -2859,7 +3008,7 @@ export declare interface ThinkingConfig {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.

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.2.1-canary.55f3f83a7";
+var version = "2.2.1-canary.9b8ab02c5";
 
 /**
  * @license
@@ -355,12 +355,50 @@ const ResponseModality = {
 /**
  * <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
  */
 const InferenceMode = {
     'PREFER_ON_DEVICE': 'prefer_on_device',
     'ONLY_ON_DEVICE': 'only_on_device',
-    'ONLY_IN_CLOUD': 'only_in_cloud'
+    'ONLY_IN_CLOUD': 'only_in_cloud',
+    'PREFER_IN_CLOUD': 'prefer_in_cloud'
+};
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+const Outcome = {
+    UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
+    OK: 'OUTCOME_OK',
+    FAILED: 'OUTCOME_FAILED',
+    DEADLINE_EXCEEDED: 'OUTCOME_DEADLINE_EXCEEDED'
+};
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+const Language = {
+    UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
+    PYTHON: 'PYTHON'
 };
 
 /**
@@ -2057,6 +2095,72 @@ function aggregateResponses(responses) {
     return aggregatedResponse;
 }
 
+/**
+ * @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.
+ */
+const errorsCausingFallback = [
+    // most network errors
+    AIErrorCode.FETCH_ERROR,
+    // fallback code for all other errors in makeRequest
+    AIErrorCode.ERROR,
+    // error due to API not being enabled in project
+    AIErrorCode.API_NOT_ENABLED
+];
+/**
+ * Dispatches a request to the appropriate backend (on-device or in-cloud)
+ * based on the inference mode.
+ *
+ * @param request - The request to be sent.
+ * @param chromeAdapter - The on-device model adapter.
+ * @param onDeviceCall - The function to call for on-device inference.
+ * @param inCloudCall - The function to call for in-cloud inference.
+ * @returns The response from the backend.
+ */
+async function callCloudOrDevice(request, chromeAdapter, onDeviceCall, inCloudCall) {
+    if (!chromeAdapter) {
+        return inCloudCall();
+    }
+    switch (chromeAdapter.mode) {
+        case InferenceMode.ONLY_ON_DEVICE:
+            if (await chromeAdapter.isAvailable(request)) {
+                return onDeviceCall();
+            }
+            throw new AIError(AIErrorCode.UNSUPPORTED, 'Inference mode is ONLY_ON_DEVICE, but an on-device model is not available.');
+        case InferenceMode.ONLY_IN_CLOUD:
+            return inCloudCall();
+        case InferenceMode.PREFER_IN_CLOUD:
+            try {
+                return await inCloudCall();
+            }
+            catch (e) {
+                if (e instanceof AIError && errorsCausingFallback.includes(e.code)) {
+                    return onDeviceCall();
+                }
+                throw e;
+            }
+        case InferenceMode.PREFER_ON_DEVICE:
+            if (await chromeAdapter.isAvailable(request)) {
+                return onDeviceCall();
+            }
+            return inCloudCall();
+        default:
+            throw new AIError(AIErrorCode.ERROR, `Unexpected infererence mode: ${chromeAdapter.mode}`);
+    }
+}
+
 /**
  * @license
  * Copyright 2024 Google LLC
@@ -2081,13 +2185,7 @@ async function generateContentStreamOnCloud(apiSettings, model, params, requestO
     /* stream */ true, JSON.stringify(params), requestOptions);
 }
 async function generateContentStream(apiSettings, model, params, chromeAdapter, requestOptions) {
-    let response;
-    if (chromeAdapter && (await chromeAdapter.isAvailable(params))) {
-        response = await chromeAdapter.generateContentStream(params);
-    }
-    else {
-        response = await generateContentStreamOnCloud(apiSettings, model, params, requestOptions);
-    }
+    const response = await callCloudOrDevice(params, chromeAdapter, () => chromeAdapter.generateContentStream(params), () => generateContentStreamOnCloud(apiSettings, model, params, requestOptions));
     return processStream(response, apiSettings); // TODO: Map streaming responses
 }
 async function generateContentOnCloud(apiSettings, model, params, requestOptions) {
@@ -2098,13 +2196,7 @@ async function generateContentOnCloud(apiSettings, model, params, requestOptions
     /* stream */ false, JSON.stringify(params), requestOptions);
 }
 async function generateContent(apiSettings, model, params, chromeAdapter, requestOptions) {
-    let response;
-    if (chromeAdapter && (await chromeAdapter.isAvailable(params))) {
-        response = await chromeAdapter.generateContent(params);
-    }
-    else {
-        response = await generateContentOnCloud(apiSettings, model, params, requestOptions);
-    }
+    const response = await callCloudOrDevice(params, chromeAdapter, () => chromeAdapter.generateContent(params), () => generateContentOnCloud(apiSettings, model, params, requestOptions));
     const generateContentResponse = await processGenerateContentResponse(response, apiSettings);
     const enhancedResponse = createEnhancedContentResponse(generateContentResponse);
     return {
@@ -2314,7 +2406,9 @@ function validateChatHistory(history) {
             functionCall: 0,
             functionResponse: 0,
             thought: 0,
-            thoughtSignature: 0
+            thoughtSignature: 0,
+            executableCode: 0,
+            codeExecutionResult: 0
         };
         for (const part of parts) {
             for (const key of VALID_PART_FIELDS) {
@@ -2515,8 +2609,8 @@ async function countTokensOnCloud(apiSettings, model, params, requestOptions) {
     return response.json();
 }
 async function countTokens(apiSettings, model, params, chromeAdapter, requestOptions) {
-    if (chromeAdapter && (await chromeAdapter.isAvailable(params))) {
-        return (await chromeAdapter.countTokens(params)).json();
+    if (chromeAdapter?.mode === InferenceMode.ONLY_ON_DEVICE) {
+        throw new AIError(AIErrorCode.UNSUPPORTED, 'countTokens() is not supported for on-device models.');
     }
     return countTokensOnCloud(apiSettings, model, params, requestOptions);
 }
@@ -3942,5 +4036,5 @@ function registerAI() {
 }
 registerAI();
 
-export { AIError, AIErrorCode, AIModel, AnyOfSchema, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, InferenceMode, IntegerSchema, LiveGenerativeModel, LiveResponseType, LiveSession, Modality, NumberSchema, ObjectSchema, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, getAI, getGenerativeModel, getImagenModel, getLiveGenerativeModel, startAudioConversation };
+export { AIError, AIErrorCode, AIModel, AnyOfSchema, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, InferenceMode, IntegerSchema, Language, LiveGenerativeModel, LiveResponseType, LiveSession, Modality, NumberSchema, ObjectSchema, Outcome, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, getAI, getGenerativeModel, getImagenModel, getLiveGenerativeModel, startAudioConversation };
 //# sourceMappingURL=index.esm.js.map