@firebase/ai 2.1.0-canary.5501791d0 → 2.1.0-canary.9b63cd60e

package/dist/esm/src/index.d.ts

@@ -3,10 +3,13 @@
  *
  * @packageDocumentation
  */
+import { AIService } from './service';
+import { ComponentContainer, InstanceFactoryOptions } from '@firebase/component';
 declare global {
     interface Window {
         [key: string]: unknown;
     }
 }
+export declare function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;
 export * from './api';
 export * from './public-types';

package/dist/esm/src/models/ai-model.d.ts

@@ -33,7 +33,7 @@ export declare abstract class AIModel {
     /**
      * @internal
      */
-    protected _apiSettings: ApiSettings;
+    _apiSettings: ApiSettings;
     /**
      * Constructs a new instance of the {@link AIModel} class.
      *

package/dist/esm/src/public-types.d.ts

@@ -35,6 +35,10 @@ export interface AI {
      * Vertex AI Gemini API (using {@link VertexAIBackend}).
      */
     backend: Backend;
+    /**
+     * Options applied to this {@link AI} instance.
+     */
+    options?: AIOptions;
     /**
      * @deprecated use `AI.backend.location` instead.
      *
@@ -83,6 +87,11 @@ export type BackendType = (typeof BackendType)[keyof typeof BackendType];
 export interface AIOptions {
     /**
      * The backend configuration to use for the AI service instance.
+     * Defaults to the Gemini Developer API backend ({@link GoogleAIBackend}).
      */
-    backend: Backend;
+    backend?: Backend;
+    /**
+     * Whether to use App Check limited use tokens. Defaults to false.
+     */
+    useLimitedUseAppCheckTokens?: boolean;
 }

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { EnhancedGenerateContentResponse, FunctionCall, GenerateContentResponse, ImagenGCSImage, ImagenInlineImage, InlineDataPart } from '../types';
+import { EnhancedGenerateContentResponse, FunctionCall, GenerateContentResponse, ImagenGCSImage, ImagenInlineImage, InlineDataPart, Part } from '../types';
 /**
  * Creates an EnhancedGenerateContentResponse object that has helper functions and
  * other modifications that improve usability.
@@ -26,15 +26,19 @@ export declare function createEnhancedContentResponse(response: GenerateContentR
  */
 export declare function addHelpers(response: GenerateContentResponse): EnhancedGenerateContentResponse;
 /**
- * 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
  */
-export declare function getText(response: GenerateContentResponse): string;
+export declare function getText(response: GenerateContentResponse, partFilter: (part: Part) => boolean): string;
 /**
- * Returns {@link FunctionCall}s associated with first candidate.
+ * Returns every {@link FunctionCall} associated with first candidate.
  */
 export declare function getFunctionCalls(response: GenerateContentResponse): FunctionCall[] | undefined;
 /**
- * Returns {@link InlineDataPart}s in the first candidate if present.
+ * Returns every {@link InlineDataPart} in the first candidate if present.
  *
  * @internal
  */

package/dist/esm/src/service.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { FirebaseApp, _FirebaseService } from '@firebase/app';
-import { AI } from './public-types';
+import { AI, AIOptions } from './public-types';
 import { AppCheckInternalComponentName, FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
 import { Provider } from '@firebase/component';
 import { FirebaseAuthInternal, FirebaseAuthInternalName } from '@firebase/auth-interop-types';
@@ -25,7 +25,10 @@ export declare class AIService implements AI, _FirebaseService {
     backend: Backend;
     auth: FirebaseAuthInternal | null;
     appCheck: FirebaseAppCheckInternal | null;
+    _options?: Omit<AIOptions, 'backend'>;
     location: string;
     constructor(app: FirebaseApp, backend: Backend, authProvider?: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>);
     _delete(): Promise<void>;
+    set options(optionsToSet: AIOptions);
+    get options(): AIOptions | undefined;
 }

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

@@ -38,6 +38,11 @@ export interface TextPart {
     inlineData?: never;
     functionCall?: never;
     functionResponse?: never;
+    thought?: boolean;
+    /**
+     * @internal
+     */
+    thoughtSignature?: string;
 }
 /**
  * Content part interface if the part represents an image.
@@ -52,6 +57,11 @@ export interface InlineDataPart {
      * Applicable if `inlineData` is a video.
      */
     videoMetadata?: VideoMetadata;
+    thought?: boolean;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
 }
 /**
  * Describes the input video content.
@@ -78,6 +88,11 @@ export interface FunctionCallPart {
     inlineData?: never;
     functionCall: FunctionCall;
     functionResponse?: never;
+    thought?: boolean;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
 }
 /**
  * Content part interface if the part represents {@link FunctionResponse}.
@@ -88,6 +103,11 @@ export interface FunctionResponsePart {
     inlineData?: never;
     functionCall?: never;
     functionResponse: FunctionResponse;
+    thought?: boolean;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
 }
 /**
  * Content part interface if the part represents {@link FileData}
@@ -99,6 +119,11 @@ export interface FileDataPart {
     functionCall?: never;
     functionResponse?: never;
     fileData: FileData;
+    thought?: boolean;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
 }
 /**
  * A predicted {@link FunctionCall} returned from the model

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

@@ -305,4 +305,13 @@ export interface ThinkingConfig {
      * feature or if the specified budget is not within the model's supported range.
      */
     thinkingBudget?: number;
+    /**
+     * Whether to include "thought summaries" in the model's response.
+     *
+     * @remarks
+     * Thought summaries provide a brief overview of the model's internal thinking process,
+     * offering insight into how it arrived at the final answer. This can be useful for
+     * debugging, understanding the model's reasoning, and verifying its accuracy.
+     */
+    includeThoughts?: boolean;
 }

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

@@ -48,15 +48,34 @@ export interface EnhancedGenerateContentResponse extends GenerateContentResponse
      */
     text: () => string;
     /**
-     * Aggregates and returns all {@link InlineDataPart}s from the {@link GenerateContentResponse}'s
-     * first candidate.
-     *
-     * @returns An array of {@link InlineDataPart}s containing data from the response, if available.
+     * Aggregates and returns every {@link InlineDataPart} from the first candidate of
+     * {@link GenerateContentResponse}.
      *
      * @throws If the prompt or candidate was blocked.
      */
     inlineDataParts: () => InlineDataPart[] | undefined;
+    /**
+     * Aggregates and returns every {@link FunctionCall} from the first candidate of
+     * {@link GenerateContentResponse}.
+     *
+     * @throws If the prompt or candidate was blocked.
+     */
     functionCalls: () => FunctionCall[] | undefined;
+    /**
+     * Aggregates and returns every {@link TextPart} with their `thought` property set
+     * to `true` from the first candidate of {@link GenerateContentResponse}.
+     *
+     * @throws If the prompt or candidate was blocked.
+     *
+     * @remarks
+     * Thought summaries provide a brief overview of the model's internal thinking process,
+     * offering insight into how it arrived at the final answer. This can be useful for
+     * debugging, understanding the model's reasoning, and verifying its accuracy.
+     *
+     * Thoughts will only be included if {@link ThinkingConfig.includeThoughts} is
+     * set to `true`.
+     */
+    thoughtSummary: () => string | undefined;
 }
 /**
  * Individual response from {@link GenerativeModel.generateContent} and

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.5501791d0";
+var version = "2.1.0-canary.9b63cd60e";
 
 /**
  * @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
  */
@@ -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) {
@@ -2963,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
@@ -3026,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');
@@ -3079,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;