@firebase/ai 2.2.1-canary.a4848b401 → 2.2.1-canary.c1237662e

package/dist/esm/src/requests/hybrid-helpers.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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.
+ */
+import { GenerateContentRequest, ChromeAdapter } from '../types';
+/**
+ * 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.
+ */
+export declare function callCloudOrDevice<Response>(request: GenerateContentRequest, chromeAdapter: ChromeAdapter | undefined, onDeviceCall: () => Promise<Response>, inCloudCall: () => Promise<Response>): Promise<Response>;

package/dist/esm/src/types/chrome-adapter.d.ts

@@ -16,13 +16,13 @@
  */
 import { CountTokensRequest, GenerateContentRequest } from './requests';
 /**
- * <b>(EXPERIMENTAL)</b> Defines an inference "backend" that uses Chrome's on-device model,
+ * Defines an inference "backend" that uses Chrome's on-device model,
  * and encapsulates logic for detecting when on-device inference is
  * possible.
  *
  * These methods should not be called directly by the user.
  *
- * @public
+ * @beta
  */
 export interface ChromeAdapter {
     /**

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Role } from './enums';
+import { Language, Outcome, Role } from './enums';
 /**
  * Content type for both prompts and response candidates.
  * @public
@@ -28,7 +28,7 @@ export interface Content {
  * part types.
  * @public
  */
-export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
 /**
  * Content part interface if the part represents a text string.
  * @public
@@ -43,6 +43,8 @@ export interface TextPart {
      * @internal
      */
     thoughtSignature?: string;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 /**
  * Content part interface if the part represents an image.
@@ -62,6 +64,8 @@ export interface InlineDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 /**
  * Describes the input video content.
@@ -93,6 +97,8 @@ export interface FunctionCallPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 /**
  * Content part interface if the part represents {@link FunctionResponse}.
@@ -108,6 +114,8 @@ export interface FunctionResponsePart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 /**
  * Content part interface if the part represents {@link FileData}
@@ -124,6 +132,77 @@ export interface FileDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
+}
+/**
+ * Represents the code that is executed by the model.
+ *
+ * @public
+ */
+export interface ExecutableCodePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: ExecutableCode;
+    codeExecutionResult?: never;
+}
+/**
+ * Represents the code execution result from the model.
+ *
+ * @public
+ */
+export interface CodeExecutionResultPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: CodeExecutionResult;
+}
+/**
+ * An interface for executable code returned by the model.
+ *
+ * @public
+ */
+export interface ExecutableCode {
+    /**
+     * The programming language of the code.
+     */
+    language?: Language;
+    /**
+     * The source code to be executed.
+     */
+    code?: string;
+}
+/**
+ * The results of code execution run by the model.
+ *
+ * @public
+ */
+export 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;
 }
 /**
  * A predicted {@link FunctionCall} returned from the model

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

@@ -317,18 +317,67 @@ export declare const ResponseModality: {
  */
 export type ResponseModality = (typeof ResponseModality)[keyof typeof ResponseModality];
 /**
- * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
- * @public
+ *
+ * @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.
+ *
+ * @beta
  */
 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
+ *
+ * @beta
  */
 export type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
+/**
+ * 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 type Outcome = (typeof Outcome)[keyof typeof Outcome];
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export type Language = (typeof Language)[keyof typeof Language];

package/dist/esm/src/types/language-model.d.ts

@@ -39,9 +39,8 @@ export declare enum Availability {
     'AVAILABLE' = "available"
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
- * @public
+ * @beta
  */
 export interface LanguageModelCreateCoreOptions {
     topK?: number;
@@ -49,69 +48,60 @@ export interface LanguageModelCreateCoreOptions {
     expectedInputs?: LanguageModelExpected[];
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
- * @public
+ * @beta
  */
 export interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
     signal?: AbortSignal;
     initialPrompts?: LanguageModelMessage[];
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Options for an on-device language model prompt.
- * @public
+ * @beta
  */
 export interface LanguageModelPromptOptions {
     responseConstraint?: object;
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Options for the expected inputs for an on-device language model.
- * @public
+ * @beta
  */ export interface LanguageModelExpected {
     type: LanguageModelMessageType;
     languages?: string[];
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * An on-device language model prompt.
- * @public
+ * @beta
  */
 export type LanguageModelPrompt = LanguageModelMessage[];
 /**
- * <b>(EXPERIMENTAL)</b>
  * An on-device language model message.
- * @public
+ * @beta
  */
 export interface LanguageModelMessage {
     role: LanguageModelMessageRole;
     content: LanguageModelMessageContent[];
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * An on-device language model content object.
- * @public
+ * @beta
  */
 export interface LanguageModelMessageContent {
     type: LanguageModelMessageType;
     value: LanguageModelMessageContentValue;
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Allowable roles for on-device language model usage.
- * @public
+ * @beta
  */
 export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
 /**
- * <b>(EXPERIMENTAL)</b>
  * Allowable types for on-device language model messages.
- * @public
+ * @beta
  */
 export type LanguageModelMessageType = 'text' | 'image' | 'audio';
 /**
- * <b>(EXPERIMENTAL)</b>
  * Content formats that can be provided as on-device message content.
- * @public
+ * @beta
  */
 export type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer | BufferSource | string;

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

@@ -218,7 +218,7 @@ export interface RequestOptions {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export type Tool = FunctionDeclarationsTool | GoogleSearchTool;
+export type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
 /**
  * Structured representation of a function declaration as defined by the
  * {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
@@ -262,8 +262,6 @@ export 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}
@@ -272,6 +270,18 @@ export interface GoogleSearchTool {
      */
     googleSearch: GoogleSearch;
 }
+/**
+ * A tool that enables the model to use code execution.
+ *
+ * @public
+ */
+export interface CodeExecutionTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     */
+    codeExecution: {};
+}
 /**
  * Specifies the Google Search configuration.
  *
@@ -315,19 +325,17 @@ export interface FunctionCallingConfig {
     allowedFunctionNames?: string[];
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Encapsulates configuration for on-device inference.
  *
- * @public
+ * @beta
  */
 export interface OnDeviceParams {
     createOptions?: LanguageModelCreateOptions;
     promptOptions?: LanguageModelPromptOptions;
 }
 /**
- * <b>(EXPERIMENTAL)</b>
  * Configures hybrid inference.
- * @public
+ * @beta
  */
 export interface HybridParams {
     /**

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.2.1-canary.a4848b401";
+var version = "2.2.1-canary.c1237662e";
 
 /**
  * @license
@@ -357,14 +357,51 @@ const ResponseModality = {
     AUDIO: 'AUDIO'
 };
 /**
- * <b>(EXPERIMENTAL)</b>
  * Determines whether inference happens on-device or in-cloud.
- * @public
+ *
+ * @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.
+ *
+ * @beta
  */
 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'
 };
 
 /**
@@ -2061,6 +2098,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
@@ -2085,13 +2188,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) {
@@ -2102,13 +2199,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 {
@@ -2318,7 +2409,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) {
@@ -2519,8 +2612,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);
 }
@@ -3972,12 +4065,14 @@ exports.ImagenPersonFilterLevel = ImagenPersonFilterLevel;
 exports.ImagenSafetyFilterLevel = ImagenSafetyFilterLevel;
 exports.InferenceMode = InferenceMode;
 exports.IntegerSchema = IntegerSchema;
+exports.Language = Language;
 exports.LiveGenerativeModel = LiveGenerativeModel;
 exports.LiveResponseType = LiveResponseType;
 exports.LiveSession = LiveSession;
 exports.Modality = Modality;
 exports.NumberSchema = NumberSchema;
 exports.ObjectSchema = ObjectSchema;
+exports.Outcome = Outcome;
 exports.POSSIBLE_ROLES = POSSIBLE_ROLES;
 exports.ResponseModality = ResponseModality;
 exports.Schema = Schema;