Skip to content

Commit 0efb0d0

Browse files
committed
Address doc comments
1 parent d32c661 commit 0efb0d0

16 files changed

+69
-118
lines changed

common/api-review/ai.api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,6 @@ export class ChatSession {
139139

140140
// @public
141141
export interface ChromeAdapter {
142-
countTokens(_request: CountTokensRequest): Promise<Response>;
143142
generateContent(request: GenerateContentRequest): Promise<Response>;
144143
generateContentStream(request: GenerateContentRequest): Promise<Response>;
145144
isAvailable(request: GenerateContentRequest): Promise<boolean>;

docs-devsite/ai.chromeadapter.md

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# ChromeAdapter interface
13-
(EXPERIMENTAL)
14-
15-
Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device is possible.
13+
<b>(EXPERIMENTAL)</b> Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device inference is possible.
1614

1715
These methods should not be called directly by the user.
1816

@@ -26,36 +24,15 @@ export interface ChromeAdapter
2624

2725
| Method | Description |
2826
| --- | --- |
29-
| [countTokens(\_request)](./ai.chromeadapter.md#chromeadaptercounttokens) | Stub - not yet available for on-device. |
30-
| [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> |
31-
| [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> |
32-
| [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> |
33-
34-
## ChromeAdapter.countTokens()
35-
36-
Stub - not yet available for on-device.
37-
38-
<b>Signature:</b>
39-
40-
```typescript
41-
countTokens(_request: CountTokensRequest): Promise<Response>;
42-
```
43-
44-
#### Parameters
45-
46-
| Parameter | Type | Description |
47-
| --- | --- | --- |
48-
| \_request | [CountTokensRequest](./ai.counttokensrequest.md#counttokensrequest_interface) | |
49-
50-
<b>Returns:</b>
51-
52-
Promise&lt;Response&gt;
27+
| [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> |
28+
| [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 content using in-cloud inference.</p> |
29+
| [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) | Checks if the on-device model is capable of handling a given request. |
5330

5431
## ChromeAdapter.generateContent()
5532

56-
Generates content on device.
33+
Generates content using on-device inference.
5734

58-
<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content in Cloud.</p>
35+
<p>This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content using in-cloud inference.</p>
5936

6037
<b>Signature:</b>
6138

@@ -73,13 +50,11 @@ generateContent(request: GenerateContentRequest): Promise<Response>;
7350

7451
Promise&lt;Response&gt;
7552

76-
Response, so we can reuse common response formatting.
77-
7853
## ChromeAdapter.generateContentStream()
7954

80-
Generates content stream on device.
55+
Generates a content stream using on-device inference.
8156

82-
<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating content in Cloud.</p>
57+
<p>This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating content using in-cloud inference.</p>
8358

8459
<b>Signature:</b>
8560

@@ -97,15 +72,9 @@ generateContentStream(request: GenerateContentRequest): Promise<Response>;
9772

9873
Promise&lt;Response&gt;
9974

100-
Response, so we can reuse common response formatting.
101-
10275
## ChromeAdapter.isAvailable()
10376

104-
Checks if a given request can be made on-device.
105-
106-
<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>
107-
108-
<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>
77+
Checks if the on-device model is capable of handling a given request.
10978

11079
<b>Signature:</b>
11180

@@ -117,7 +86,7 @@ isAvailable(request: GenerateContentRequest): Promise<boolean>;
11786

11887
| Parameter | Type | Description |
11988
| --- | --- | --- |
120-
| request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | |
89+
| request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | A potential request to be passed to the model. |
12190

12291
<b>Returns:</b>
12392

docs-devsite/ai.hybridparams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# HybridParams interface
13-
(EXPERIMENTAL) Configures hybrid inference.
13+
<b>(EXPERIMENTAL)</b> Configures hybrid inference.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelcreatecoreoptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelCreateCoreOptions interface
13-
(EXPERIMENTAL) Used to configure the creation of an on-device language model session.
13+
<b>(EXPERIMENTAL)</b> Configures the creation of an on-device language model session.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelcreateoptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelCreateOptions interface
13-
(EXPERIMENTAL) Used to configure the creation of an on-device language model session.
13+
<b>(EXPERIMENTAL)</b> Configures the creation of an on-device language model session.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelexpected.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelExpected interface
13-
(EXPERIMENTAL) Options for an on-device language model expected inputs.
13+
<b>(EXPERIMENTAL)</b> Options for the expected inputs for an on-device language model.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelmessage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelMessage interface
13-
(EXPERIMENTAL) An on-device language model message.
13+
<b>(EXPERIMENTAL)</b> An on-device language model message.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelmessagecontent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelMessageContent interface
13-
(EXPERIMENTAL) An on-device language model content object.
13+
<b>(EXPERIMENTAL)</b> An on-device language model content object.
1414

1515
<b>Signature:</b>
1616

docs-devsite/ai.languagemodelpromptoptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# LanguageModelPromptOptions interface
13-
(EXPERIMENTAL) Options for an on-device language model prompt.
13+
<b>(EXPERIMENTAL)</b> Options for an on-device language model prompt.
1414

1515
<b>Signature:</b>
1616

0 commit comments

Comments
 (0)