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

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/methods/chrome-adapter.d.ts

@@ -34,24 +34,25 @@ export declare class ChromeAdapterImpl implements ChromeAdapter {
     /**
      * 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.
      */
     isAvailable(request: GenerateContentRequest): Promise<boolean>;
     /**
      * 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.
      */
@@ -59,8 +60,9 @@ export declare class ChromeAdapterImpl implements ChromeAdapter {
     /**
      * 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.
      */
@@ -77,11 +79,11 @@ export declare class ChromeAdapterImpl implements ChromeAdapter {
     /**
      * 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.
      */
     private download;
     /**
@@ -99,12 +101,12 @@ export declare class ChromeAdapterImpl implements ChromeAdapter {
     /**
      * 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.
      */
     private createSession;
     /**

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/chrome-adapter.d.ts

@@ -34,16 +34,18 @@ export interface ChromeAdapter {
     /**
      * Generates content using on-device inference.
      *
-     * <p>This is comparable to {@link GenerativeModel.generateContent} for generating
-     * content using in-cloud inference.</p>
+     * @remarks
+     * This is comparable to {@link GenerativeModel.generateContent} for generating
+     * content using in-cloud inference.
      * @param request - a standard Firebase AI {@link GenerateContentRequest}
      */
     generateContent(request: GenerateContentRequest): Promise<Response>;
     /**
      * Generates a content stream using on-device inference.
      *
-     * <p>This is comparable to {@link GenerativeModel.generateContentStream} for generating
-     * a content stream using in-cloud inference.</p>
+     * @remarks
+     * This is comparable to {@link GenerativeModel.generateContentStream} for generating
+     * a content stream using in-cloud inference.
      * @param request - a standard Firebase AI {@link GenerateContentRequest}
      */
     generateContentStream(request: GenerateContentRequest): Promise<Response>;

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

@@ -146,7 +146,10 @@ export interface RequestOptions {
      */
     timeout?: number;
     /**
-     * Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com
+     * Base url for endpoint. Defaults to
+     * https://firebasevertexai.googleapis.com, which is the
+     * {@link https://console.cloud.google.com/apis/library/firebasevertexai.googleapis.com?project=_ | Firebase AI Logic API}
+     * (used regardless of your chosen Gemini API provider).
      */
     baseUrl?: string;
 }
@@ -302,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