Merge branch 'main' into realtime-backoff

Author: Athira M

.changeset/purple-chairs-wait.md

@@ -24,15 +24,15 @@ export interface ChromeAdapter
 
 |  Method | Description |
 |  --- | --- |
-|  [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | Generates content using on-device inference.<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content using in-cloud inference.</p> |
-|  [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | Generates a content stream using on-device inference.<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating a content stream using in-cloud inference.</p> |
+|  [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | Generates content using on-device inference. |
+|  [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | Generates a content stream using on-device inference. |
 |  [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) | Checks if the on-device model is capable of handling a given request. |
 
 ## ChromeAdapter.generateContent()
 
 Generates content using on-device inference.
 
-<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content using in-cloud inference.</p>
+This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content using in-cloud inference.
 
 <b>Signature:</b>
 
@@ -54,7 +54,7 @@ Promise&lt;Response&gt;
 
 Generates a content stream using on-device inference.
 
-<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating a content stream using in-cloud inference.</p>
+This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating a content stream using in-cloud inference.
 
 <b>Signature:</b>
 

.changeset/strong-avocados-prove.md

@@ -22,12 +22,12 @@ export interface RequestOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [baseUrl](./ai.requestoptions.md#requestoptionsbaseurl) | string | Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com |
+|  [baseUrl](./ai.requestoptions.md#requestoptionsbaseurl) | string | Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com, which is the [Firebase AI Logic API](https://console.cloud.google.com/apis/library/firebasevertexai.googleapis.com?project=_) (used regardless of your chosen Gemini API provider). |
 |  [timeout](./ai.requestoptions.md#requestoptionstimeout) | number | Request timeout in milliseconds. Defaults to 180 seconds (180000ms). |
 
 ## RequestOptions.baseUrl
 
-Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com
+Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com, which is the [Firebase AI Logic API](https://console.cloud.google.com/apis/library/firebasevertexai.googleapis.com?project=_) (used regardless of your chosen Gemini API provider).
 
 <b>Signature:</b>
 

docs-devsite/ai.chromeadapter.md

@@ -8,8 +8,8 @@
     "test:debug": "karma start --browsers Chrome --auto-watch"
   },
   "dependencies": {
-    "@firebase/app": "0.14.0",
-    "@firebase/app-compat": "0.5.0",
+    "@firebase/app": "0.14.1",
+    "@firebase/app-compat": "0.5.1",
     "@firebase/analytics": "0.10.18",
     "@firebase/analytics-compat": "0.2.24",
     "@firebase/auth": "1.11.0",
@@ -18,8 +18,8 @@
     "@firebase/functions-compat": "0.4.0",
     "@firebase/messaging": "0.12.23",
     "@firebase/messaging-compat": "0.2.23",
-    "@firebase/performance": "0.7.8",
-    "@firebase/performance-compat": "0.2.21",
+    "@firebase/performance": "0.7.9",
+    "@firebase/performance-compat": "0.2.22",
     "@firebase/remote-config": "0.6.6",
     "@firebase/remote-config-compat": "0.2.19"
   },

docs-devsite/ai.requestoptions.md

@@ -14,7 +14,7 @@
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },
   "dependencies": {
-    "@firebase/app": "0.14.0",
+    "@firebase/app": "0.14.1",
     "@firebase/firestore": "4.9.0"
   },
   "devDependencies": {

integration/compat-interop/package.json

@@ -9,7 +9,7 @@
     "test:manual": "mocha --exit"
   },
   "devDependencies": {
-    "firebase": "12.0.0",
+    "firebase": "12.1.0",
     "chai": "4.5.0",
     "chromedriver": "119.0.1",
     "express": "4.21.2",

integration/firestore/package.json

@@ -1,5 +1,11 @@
 # @firebase/ai
 
+## 2.1.0
+
+### Minor Changes
+
+- [`e25317f`](https://github.com/firebase/firebase-js-sdk/commit/e25317f9f3c58305bc093e4f2e676690feb16db0) [#9029](https://github.com/firebase/firebase-js-sdk/pull/9029) - Add hybrid inference options to the Firebase AI SDK.
+
 ## 2.0.0
 
 ### Major Changes

integration/messaging/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/ai",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The Firebase AI SDK",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "engines": {
@@ -57,7 +57,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.14.0",
+    "@firebase/app": "0.14.1",
     "@rollup/plugin-json": "6.1.0",
     "rollup": "2.79.2",
     "rollup-plugin-replace": "2.2.0",

packages/ai/CHANGELOG.md

@@ -61,17 +61,17 @@ export 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.
    */
   async isAvailable(request: GenerateContentRequest): Promise<boolean> {
     if (!this.mode) {
@@ -129,8 +129,9 @@ export class ChromeAdapterImpl implements ChromeAdapter {
   /**
    * 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.
    */
@@ -149,8 +150,9 @@ export 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.
    */
@@ -228,11 +230,11 @@ export 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(): void {
     if (this.isDownloading) {
@@ -302,12 +304,12 @@ export 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 async createSession(): Promise<LanguageModel> {
     if (!this.languageModelProvider) {