@@ -10,9 +10,7 @@ https://github.com/firebase/firebase-js-sdk
10
10
{% endcomment %}
11
11
12
12
# 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.
16
14
17
15
These methods should not be called directly by the user.
18
16
@@ -26,36 +24,15 @@ export interface ChromeAdapter
26
24
27
25
| Method | Description |
28
26
| --- | --- |
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 < ;Response > ;
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 . |
53
30
54
31
## ChromeAdapter .generateContent ()
55
32
56
- Generates content on device .
33
+ Generates content using on - device inference .
57
34
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 >
59
36
60
37
<b >Signature :</b >
61
38
@@ -73,13 +50,11 @@ generateContent(request: GenerateContentRequest): Promise<Response>;
73
50
74
51
Promise < ;Response > ;
75
52
76
- Response , so we can reuse common response formatting .
77
-
78
53
## ChromeAdapter .generateContentStream ()
79
54
80
- Generates content stream on device .
55
+ Generates a content stream using on - device inference .
81
56
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 >
83
58
84
59
<b >Signature :</b >
85
60
@@ -97,15 +72,9 @@ generateContentStream(request: GenerateContentRequest): Promise<Response>;
97
72
98
73
Promise < ;Response > ;
99
74
100
- Response , so we can reuse common response formatting .
101
-
102
75
## ChromeAdapter .isAvailable ()
103
76
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 .
109
78
110
79
<b >Signature :</b >
111
80
@@ -117,7 +86,7 @@ isAvailable(request: GenerateContentRequest): Promise<boolean>;
117
86
118
87
| Parameter | Type | Description |
119
88
| --- | --- | --- |
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 . |
121
90
122
91
<b >Returns :</b >
123
92
0 commit comments