@firebase/ai 2.1.0-canary.44d8d742f → 2.1.0-canary.5501791d0

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/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/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;
 }

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.5501791d0";
 
 /**
  * @license
@@ -2373,17 +2373,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 +2424,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 +2439,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 +2492,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 +2550,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) {