add experimental tag to ChromeAdapter

Author: hsubox76

docs-devsite/ai.chromeadapter.md

@@ -10,8 +10,12 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # ChromeAdapter interface
+(EXPERIMENTAL)
+
 Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device is possible.
 
+These methods should not be called directly by the user.
+
 <b>Signature:</b>
 
 ```typescript
@@ -22,13 +26,15 @@ export interface ChromeAdapter
 
 |  Method | Description |
 |  --- | --- |
-|  [countTokens(\_request)](./ai.chromeadapter.md#chromeadaptercounttokens) |  |
-|  [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) |  |
-|  [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) |  |
-|  [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) |  |
+|  [countTokens(\_request)](./ai.chromeadapter.md#chromeadaptercounttokens) | Stub - not yet available for on-device. |
+|  [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | Generates content on device.<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content in Cloud.</p> |
+|  [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | Generates content stream on device.<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating content in Cloud.</p> |
+|  [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) | 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><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. If instance variables weren't already part of the API, we could consider a better separation of concerns.</p> |
 
 ## ChromeAdapter.countTokens()
 
+Stub - not yet available for on-device.
+
 <b>Signature:</b>
 
 ```typescript
@@ -47,6 +53,10 @@ Promise&lt;Response&gt;
 
 ## ChromeAdapter.generateContent()
 
+Generates content on device.
+
+<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content in Cloud.</p>
+
 <b>Signature:</b>
 
 ```typescript
@@ -57,14 +67,20 @@ generateContent(request: GenerateContentRequest): Promise<Response>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) |  |
+|  request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | a standard Firebase AI [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) |
 
 <b>Returns:</b>
 
 Promise&lt;Response&gt;
 
+, so we can reuse common response formatting.
+
 ## ChromeAdapter.generateContentStream()
 
+Generates content stream on device.
+
+<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating content in Cloud.</p>
+
 <b>Signature:</b>
 
 ```typescript
@@ -75,14 +91,22 @@ generateContentStream(request: GenerateContentRequest): Promise<Response>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) |  |
+|  request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | a standard Firebase AI [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) |
 
 <b>Returns:</b>
 
 Promise&lt;Response&gt;
 
+, so we can reuse common response formatting.
+
 ## ChromeAdapter.isAvailable()
 
+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>
+
+<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. If instance variables weren't already part of the API, we could consider a better separation of concerns.</p>
+
 <b>Signature:</b>
 
 ```typescript

docs-devsite/ai.md

@@ -51,7 +51,7 @@ The Firebase AI Web SDK.
 |  [AI](./ai.ai.md#ai_interface) | An instance of the Firebase AI SDK.<!-- -->Do not create this instance directly. Instead, use [getAI()](./ai.md#getai_a94a413)<!-- -->. |
 |  [AIOptions](./ai.aioptions.md#aioptions_interface) | Options for initializing the AI service using [getAI()](./ai.md#getai_a94a413)<!-- -->. This allows specifying which backend to use (Vertex AI Gemini API or Gemini Developer API) and configuring its specific options (like location for Vertex AI). |
 |  [BaseParams](./ai.baseparams.md#baseparams_interface) | Base parameters for a number of methods. |
-|  [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) | Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device is possible. |
+|  [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) | (EXPERIMENTAL)<!-- -->Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device is possible.<!-- -->These methods should not be called directly by the user. |
 |  [Citation](./ai.citation.md#citation_interface) | A single citation. |
 |  [CitationMetadata](./ai.citationmetadata.md#citationmetadata_interface) | Citation metadata that may be found on a [GenerateContentCandidate](./ai.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->. |
 |  [Content](./ai.content.md#content_interface) | Content type for both prompts and response candidates. |

packages/ai/src/types/chrome-adapter.ts

@@ -18,6 +18,8 @@
 import { CountTokensRequest, GenerateContentRequest } from './requests';
 
 /**
+ * (EXPERIMENTAL)
+ * 
  * Defines an inference "backend" that uses Chrome's on-device model,
  * and encapsulates logic for detecting when on-device is possible.
  *