@firebase/ai 2.2.1 → 2.3.0-canary.0ffcb26af

package/dist/index.node.mjs

@@ -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";
+var version = "2.3.0-canary.0ffcb26af";
 
 /**
  * @license
@@ -297,14 +297,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'
 };
 
 /**
@@ -323,6 +360,45 @@ const InferenceMode = {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * The status of a URL retrieval.
+ *
+ * @remarks
+ * <b>URL_RETRIEVAL_STATUS_UNSPECIFIED:</b> Unspecified retrieval status.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_SUCCESS:</b> The URL retrieval was successful.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_ERROR:</b> The URL retrieval failed.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
+ * <br/>
+ *
+ * @beta
+ */
+const URLRetrievalStatus = {
+    /**
+     * Unspecified retrieval status.
+     */
+    URL_RETRIEVAL_STATUS_UNSPECIFIED: 'URL_RETRIEVAL_STATUS_UNSPECIFIED',
+    /**
+     * The URL retrieval was successful.
+     */
+    URL_RETRIEVAL_STATUS_SUCCESS: 'URL_RETRIEVAL_STATUS_SUCCESS',
+    /**
+     * The URL retrieval failed.
+     */
+    URL_RETRIEVAL_STATUS_ERROR: 'URL_RETRIEVAL_STATUS_ERROR',
+    /**
+     * The URL retrieval failed because the content is behind a paywall.
+     */
+    URL_RETRIEVAL_STATUS_PAYWALL: 'URL_RETRIEVAL_STATUS_PAYWALL',
+    /**
+     * The URL retrieval failed because the content is unsafe.
+     */
+    URL_RETRIEVAL_STATUS_UNSAFE: 'URL_RETRIEVAL_STATUS_UNSAFE'
+};
 /**
  * The types of responses that can be returned by {@link LiveSession.receive}.
  *
@@ -1526,7 +1602,8 @@ function mapGenerateContentCandidates(candidates) {
                 finishMessage: candidate.finishMessage,
                 safetyRatings: mappedSafetyRatings,
                 citationMetadata,
-                groundingMetadata: candidate.groundingMetadata
+                groundingMetadata: candidate.groundingMetadata,
+                urlContextMetadata: candidate.urlContextMetadata
             };
             mappedCandidates.push(mappedCandidate);
         });
@@ -1696,6 +1773,17 @@ function aggregateResponses(responses) {
                     candidate.safetyRatings;
                 aggregatedResponse.candidates[i].groundingMetadata =
                     candidate.groundingMetadata;
+                // The urlContextMetadata object is defined in the first chunk of the response stream.
+                // In all subsequent chunks, the urlContextMetadata object will be undefined. We need to
+                // make sure that we don't overwrite the first value urlContextMetadata object with undefined.
+                // FIXME: What happens if we receive a second, valid urlContextMetadata object?
+                const urlContextMetadata = candidate.urlContextMetadata;
+                if (typeof urlContextMetadata === 'object' &&
+                    urlContextMetadata !== null &&
+                    Object.keys(urlContextMetadata).length > 0) {
+                    aggregatedResponse.candidates[i].urlContextMetadata =
+                        urlContextMetadata;
+                }
                 /**
                  * Candidates should always have content and parts, but this handles
                  * possible malformed responses.
@@ -1734,6 +1822,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
@@ -1758,13 +1912,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) {
@@ -1775,13 +1923,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 {
@@ -1991,7 +2133,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) {
@@ -2192,8 +2336,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);
 }
@@ -3629,5 +3773,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, URLRetrievalStatus, VertexAIBackend, getAI, getGenerativeModel, getImagenModel, getLiveGenerativeModel, startAudioConversation };
 //# sourceMappingURL=index.node.mjs.map