@firebase/ai 2.1.0-canary.44d8d742f → 2.1.0-canary.84b8bed35

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.1.0-canary.44d8d742f";
+var version = "2.1.0-canary.84b8bed35";
 
 /**
  * @license
@@ -657,6 +657,12 @@ class AIService {
     _delete() {
         return Promise.resolve();
     }
+    set options(optionsToSet) {
+        this._options = optionsToSet;
+    }
+    get options() {
+        return this._options;
+    }
 }
 
 /**
@@ -841,7 +847,12 @@ class AIModel {
                 };
             }
             else if (ai.appCheck) {
-                this._apiSettings.getAppCheckToken = () => ai.appCheck.getToken();
+                if (ai.options?.useLimitedUseAppCheckTokens) {
+                    this._apiSettings.getAppCheckToken = () => ai.appCheck.getLimitedUseToken();
+                }
+                else {
+                    this._apiSettings.getAppCheckToken = () => ai.appCheck.getToken();
+                }
             }
             if (ai.auth) {
                 this._apiSettings.getAuthToken = () => ai.auth.getToken();
@@ -1104,6 +1115,28 @@ async function makeRequest(model, task, apiSettings, stream, body, requestOption
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Check that at least one candidate exists and does not have a bad
+ * finish reason. Warns if multiple candidates exist.
+ */
+function hasValidCandidates(response) {
+    if (response.candidates && response.candidates.length > 0) {
+        if (response.candidates.length > 1) {
+            logger.warn(`This response had ${response.candidates.length} ` +
+                `candidates. Returning text from the first candidate only. ` +
+                `Access response.candidates directly to use the other candidates.`);
+        }
+        if (hadBadFinishReason(response.candidates[0])) {
+            throw new AIError(AIErrorCode.RESPONSE_ERROR, `Response error: ${formatBlockErrorMessage(response)}. Response body stored in error.response`, {
+                response
+            });
+        }
+        return true;
+    }
+    else {
+        return false;
+    }
+}
 /**
  * Creates an EnhancedGenerateContentResponse object that has helper functions and
  * other modifications that improve usability.
@@ -1127,18 +1160,8 @@ function createEnhancedContentResponse(response) {
  */
 function addHelpers(response) {
     response.text = () => {
-        if (response.candidates && response.candidates.length > 0) {
-            if (response.candidates.length > 1) {
-                logger.warn(`This response had ${response.candidates.length} ` +
-                    `candidates. Returning text from the first candidate only. ` +
-                    `Access response.candidates directly to use the other candidates.`);
-            }
-            if (hadBadFinishReason(response.candidates[0])) {
-                throw new AIError(AIErrorCode.RESPONSE_ERROR, `Response error: ${formatBlockErrorMessage(response)}. Response body stored in error.response`, {
-                    response
-                });
-            }
-            return getText(response);
+        if (hasValidCandidates(response)) {
+            return getText(response, part => !part.thought);
         }
         else if (response.promptFeedback) {
             throw new AIError(AIErrorCode.RESPONSE_ERROR, `Text not available. ${formatBlockErrorMessage(response)}`, {
@@ -1147,18 +1170,20 @@ function addHelpers(response) {
         }
         return '';
     };
+    response.thoughtSummary = () => {
+        if (hasValidCandidates(response)) {
+            const result = getText(response, part => !!part.thought);
+            return result === '' ? undefined : result;
+        }
+        else if (response.promptFeedback) {
+            throw new AIError(AIErrorCode.RESPONSE_ERROR, `Thought summary not available. ${formatBlockErrorMessage(response)}`, {
+                response
+            });
+        }
+        return undefined;
+    };
     response.inlineDataParts = () => {
-        if (response.candidates && response.candidates.length > 0) {
-            if (response.candidates.length > 1) {
-                logger.warn(`This response had ${response.candidates.length} ` +
-                    `candidates. Returning data from the first candidate only. ` +
-                    `Access response.candidates directly to use the other candidates.`);
-            }
-            if (hadBadFinishReason(response.candidates[0])) {
-                throw new AIError(AIErrorCode.RESPONSE_ERROR, `Response error: ${formatBlockErrorMessage(response)}. Response body stored in error.response`, {
-                    response
-                });
-            }
+        if (hasValidCandidates(response)) {
             return getInlineDataParts(response);
         }
         else if (response.promptFeedback) {
@@ -1169,17 +1194,7 @@ function addHelpers(response) {
         return undefined;
     };
     response.functionCalls = () => {
-        if (response.candidates && response.candidates.length > 0) {
-            if (response.candidates.length > 1) {
-                logger.warn(`This response had ${response.candidates.length} ` +
-                    `candidates. Returning function calls from the first candidate only. ` +
-                    `Access response.candidates directly to use the other candidates.`);
-            }
-            if (hadBadFinishReason(response.candidates[0])) {
-                throw new AIError(AIErrorCode.RESPONSE_ERROR, `Response error: ${formatBlockErrorMessage(response)}. Response body stored in error.response`, {
-                    response
-                });
-            }
+        if (hasValidCandidates(response)) {
             return getFunctionCalls(response);
         }
         else if (response.promptFeedback) {
@@ -1192,13 +1207,17 @@ function addHelpers(response) {
     return response;
 }
 /**
- * Returns all text found in all parts of first candidate.
+ * Returns all text from the first candidate's parts, filtering by whether
+ * `partFilter()` returns true.
+ *
+ * @param response - The `GenerateContentResponse` from which to extract text.
+ * @param partFilter - Only return `Part`s for which this returns true
  */
-function getText(response) {
+function getText(response, partFilter) {
     const textStrings = [];
     if (response.candidates?.[0].content?.parts) {
         for (const part of response.candidates?.[0].content?.parts) {
-            if (part.text) {
+            if (part.text && partFilter(part)) {
                 textStrings.push(part.text);
             }
         }
@@ -1211,7 +1230,7 @@ function getText(response) {
     }
 }
 /**
- * Returns {@link FunctionCall}s associated with first candidate.
+ * Returns every {@link FunctionCall} associated with first candidate.
  */
 function getFunctionCalls(response) {
     const functionCalls = [];
@@ -1230,7 +1249,7 @@ function getFunctionCalls(response) {
     }
 }
 /**
- * Returns {@link InlineDataPart}s in the first candidate if present.
+ * Returns every {@link InlineDataPart} in the first candidate if present.
  *
  * @internal
  */
@@ -1310,7 +1329,7 @@ async function handlePredictResponse(response) {
             });
         }
         else {
-            throw new AIError(AIErrorCode.RESPONSE_ERROR, `Predictions array in response has missing properties. Response: ${JSON.stringify(responseJson)}`);
+            throw new AIError(AIErrorCode.RESPONSE_ERROR, `Unexpected element in 'predictions' array in response: '${JSON.stringify(prediction)}'`);
         }
     }
     return { images, filteredReason };
@@ -1878,12 +1897,14 @@ const VALID_PART_FIELDS = [
     'text',
     'inlineData',
     'functionCall',
-    'functionResponse'
+    'functionResponse',
+    'thought',
+    'thoughtSignature'
 ];
 const VALID_PARTS_PER_ROLE = {
     user: ['text', 'inlineData'],
     function: ['functionResponse'],
-    model: ['text', 'functionCall'],
+    model: ['text', 'functionCall', 'thought', 'thoughtSignature'],
     // System instructions shouldn't be in history anyway.
     system: ['text']
 };
@@ -1905,7 +1926,7 @@ function validateChatHistory(history) {
             throw new AIError(AIErrorCode.INVALID_CONTENT, `Each item should include role field. Got ${role} but valid roles are: ${JSON.stringify(POSSIBLE_ROLES)}`);
         }
         if (!Array.isArray(parts)) {
-            throw new AIError(AIErrorCode.INVALID_CONTENT, `Content should have 'parts' but property with an array of Parts`);
+            throw new AIError(AIErrorCode.INVALID_CONTENT, `Content should have 'parts' property with an array of Parts`);
         }
         if (parts.length === 0) {
             throw new AIError(AIErrorCode.INVALID_CONTENT, `Each Content should have at least one part`);
@@ -1914,7 +1935,9 @@ function validateChatHistory(history) {
             text: 0,
             inlineData: 0,
             functionCall: 0,
-            functionResponse: 0
+            functionResponse: 0,
+            thought: 0,
+            thoughtSignature: 0
         };
         for (const part of parts) {
             for (const key of VALID_PART_FIELDS) {
@@ -2373,17 +2396,17 @@ class ChromeAdapterImpl {
     /**
      * Checks if a given request can be made on-device.
      *
-     * <ol>Encapsulates a few concerns:
-     *   <li>the mode</li>
-     *   <li>API existence</li>
-     *   <li>prompt formatting</li>
-     *   <li>model availability, including triggering download if necessary</li>
-     * </ol>
+     * Encapsulates a few concerns:
+     *   the mode
+     *   API existence
+     *   prompt formatting
+     *   model availability, including triggering download if necessary
      *
-     * <p>Pros: callers needn't be concerned with details of on-device availability.</p>
-     * <p>Cons: this method spans a few concerns and splits request validation from usage.
+     *
+     * Pros: callers needn't be concerned with details of on-device availability.</p>
+     * Cons: this method spans a few concerns and splits request validation from usage.
      * If instance variables weren't already part of the API, we could consider a better
-     * separation of concerns.</p>
+     * separation of concerns.
      */
     async isAvailable(request) {
         if (!this.mode) {
@@ -2424,8 +2447,9 @@ class ChromeAdapterImpl {
     /**
      * Generates content on device.
      *
-     * <p>This is comparable to {@link GenerativeModel.generateContent} for generating content in
-     * Cloud.</p>
+     * @remarks
+     * This is comparable to {@link GenerativeModel.generateContent} for generating content in
+     * Cloud.
      * @param request - a standard Firebase AI {@link GenerateContentRequest}
      * @returns {@link Response}, so we can reuse common response formatting.
      */
@@ -2438,8 +2462,9 @@ class ChromeAdapterImpl {
     /**
      * Generates content stream on device.
      *
-     * <p>This is comparable to {@link GenerativeModel.generateContentStream} for generating content in
-     * Cloud.</p>
+     * @remarks
+     * This is comparable to {@link GenerativeModel.generateContentStream} for generating content in
+     * Cloud.
      * @param request - a standard Firebase AI {@link GenerateContentRequest}
      * @returns {@link Response}, so we can reuse common response formatting.
      */
@@ -2490,11 +2515,11 @@ class ChromeAdapterImpl {
     /**
      * Triggers out-of-band download of an on-device model.
      *
-     * <p>Chrome only downloads models as needed. Chrome knows a model is needed when code calls
-     * LanguageModel.create.</p>
+     * Chrome only downloads models as needed. Chrome knows a model is needed when code calls
+     * LanguageModel.create.
      *
-     * <p>Since Chrome manages the download, the SDK can only avoid redundant download requests by
-     * tracking if a download has previously been requested.</p>
+     * Since Chrome manages the download, the SDK can only avoid redundant download requests by
+     * tracking if a download has previously been requested.
      */
     download() {
         if (this.isDownloading) {
@@ -2548,12 +2573,12 @@ class ChromeAdapterImpl {
     /**
      * Abstracts Chrome session creation.
      *
-     * <p>Chrome uses a multi-turn session for all inference. Firebase AI uses single-turn for all
+     * Chrome uses a multi-turn session for all inference. Firebase AI uses single-turn for all
      * inference. To map the Firebase AI API to Chrome's API, the SDK creates a new session for all
-     * inference.</p>
+     * inference.
      *
-     * <p>Chrome will remove a model from memory if it's no longer in use, so this method ensures a
-     * new session is created before an old session is destroyed.</p>
+     * Chrome will remove a model from memory if it's no longer in use, so this method ensures a
+     * new session is created before an old session is destroyed.
      */
     async createSession() {
         if (!this.languageModelProvider) {
@@ -2961,14 +2986,20 @@ class ImagenImageFormat {
  *
  * @public
  */
-function getAI(app$1 = app.getApp(), options = { backend: new GoogleAIBackend() }) {
+function getAI(app$1 = app.getApp(), options) {
     app$1 = util.getModularInstance(app$1);
     // Dependencies
     const AIProvider = app._getProvider(app$1, AI_TYPE);
-    const identifier = encodeInstanceIdentifier(options.backend);
-    return AIProvider.getImmediate({
+    const backend = options?.backend ?? new GoogleAIBackend();
+    const finalOptions = {
+        useLimitedUseAppCheckTokens: options?.useLimitedUseAppCheckTokens ?? false
+    };
+    const identifier = encodeInstanceIdentifier(backend);
+    const aiInstance = AIProvider.getImmediate({
         identifier
     });
+    aiInstance.options = finalOptions;
+    return aiInstance;
 }
 /**
  * Returns a {@link GenerativeModel} class with methods for inference
@@ -3024,18 +3055,19 @@ function getImagenModel(ai, modelParams, requestOptions) {
  *
  * @packageDocumentation
  */
+function factory(container, { instanceIdentifier }) {
+    if (!instanceIdentifier) {
+        throw new AIError(AIErrorCode.ERROR, 'AIService instance identifier is undefined.');
+    }
+    const backend = decodeInstanceIdentifier(instanceIdentifier);
+    // getImmediate for FirebaseApp will always succeed
+    const app = container.getProvider('app').getImmediate();
+    const auth = container.getProvider('auth-internal');
+    const appCheckProvider = container.getProvider('app-check-internal');
+    return new AIService(app, backend, auth, appCheckProvider);
+}
 function registerAI() {
-    app._registerComponent(new component.Component(AI_TYPE, (container, { instanceIdentifier }) => {
-        if (!instanceIdentifier) {
-            throw new AIError(AIErrorCode.ERROR, 'AIService instance identifier is undefined.');
-        }
-        const backend = decodeInstanceIdentifier(instanceIdentifier);
-        // getImmediate for FirebaseApp will always succeed
-        const app = container.getProvider('app').getImmediate();
-        const auth = container.getProvider('auth-internal');
-        const appCheckProvider = container.getProvider('app-check-internal');
-        return new AIService(app, backend, auth, appCheckProvider);
-    }, "PUBLIC" /* ComponentType.PUBLIC */).setMultipleInstances(true));
+    app._registerComponent(new component.Component(AI_TYPE, factory, "PUBLIC" /* ComponentType.PUBLIC */).setMultipleInstances(true));
     app.registerVersion(name, version);
     // BUILD_TARGET will be replaced by values like esm, cjs, etc during the compilation
     app.registerVersion(name, version, 'cjs2020');
@@ -3077,6 +3109,7 @@ exports.Schema = Schema;
 exports.SchemaType = SchemaType;
 exports.StringSchema = StringSchema;
 exports.VertexAIBackend = VertexAIBackend;
+exports.factory = factory;
 exports.getAI = getAI;
 exports.getGenerativeModel = getGenerativeModel;
 exports.getImagenModel = getImagenModel;