Skip to content

Commit e9dc43e

Browse files
hsubox76hsubox76
committed
Make ChromeAdapter optional, fix doc comments
1 parent e5e8c36 commit e9dc43e

35 files changed

+424
-164
lines changed

‎common/api-review/ai.api.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,7 @@ export class BooleanSchema extends Schema {
125125

126126
// @public
127127
export class ChatSession {
128-
// Warning: (ae-forgotten-export) The symbol "ChromeAdapter" needs to be exported by the entry point index.d.ts
129-
constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapter, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
128+
constructor(apiSettings: ApiSettings, model: string, chromeAdapter?: ChromeAdapter | undefined, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
130129
getHistory(): Promise<Content[]>;
131130
// (undocumented)
132131
model: string;
@@ -138,6 +137,18 @@ export class ChatSession {
138137
sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
139138
}
140139

140+
// @public
141+
export interface ChromeAdapter {
142+
// (undocumented)
143+
countTokens(_request: CountTokensRequest): Promise<Response>;
144+
// (undocumented)
145+
generateContent(request: GenerateContentRequest): Promise<Response>;
146+
// (undocumented)
147+
generateContentStream(request: GenerateContentRequest): Promise<Response>;
148+
// (undocumented)
149+
isAvailable(request: GenerateContentRequest): Promise<boolean>;
150+
}
151+
141152
// @public
142153
export interface Citation {
143154
// (undocumented)
@@ -417,7 +428,7 @@ export interface GenerativeContentBlob {
417428

418429
// @public
419430
export class GenerativeModel extends AIModel {
420-
constructor(ai: AI, modelParams: ModelParams, chromeAdapter: ChromeAdapter, requestOptions?: RequestOptions);
431+
constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions, chromeAdapter?: ChromeAdapter | undefined);
421432
countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
422433
static DEFAULT_HYBRID_IN_CLOUD_MODEL: string;
423434
generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
@@ -609,7 +620,7 @@ export const ImagenAspectRatio: {
609620
// @beta
610621
export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];
611622

612-
// @public
623+
// @beta
613624
export interface ImagenGCSImage {
614625
gcsURI: string;
615626
mimeType: string;
@@ -691,7 +702,14 @@ export interface ImagenSafetySettings {
691702
}
692703

693704
// @public
694-
export type InferenceMode = 'prefer_on_device' | 'only_on_device' | 'only_in_cloud';
705+
export const InferenceMode: {
706+
readonly PREFER_ON_DEVICE: "prefer_on_device";
707+
readonly ONLY_ON_DEVICE: "only_on_device";
708+
readonly ONLY_IN_CLOUD: "only_in_cloud";
709+
};
710+
711+
// @public
712+
export type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
695713

696714
// @public
697715
export interface InlineDataPart {
@@ -762,6 +780,12 @@ export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
762780
// @public (undocumented)
763781
export type LanguageModelMessageType = 'text' | 'image' | 'audio';
764782

783+
// @public (undocumented)
784+
export interface LanguageModelPromptOptions {
785+
// (undocumented)
786+
responseConstraint?: object;
787+
}
788+
765789
// @public
766790
export const Modality: {
767791
readonly MODALITY_UNSPECIFIED: "MODALITY_UNSPECIFIED";
@@ -824,8 +848,6 @@ export interface ObjectSchemaRequest extends SchemaRequest {
824848
export interface OnDeviceParams {
825849
// (undocumented)
826850
createOptions?: LanguageModelCreateOptions;
827-
// Warning: (ae-forgotten-export) The symbol "LanguageModelPromptOptions" needs to be exported by the entry point index.d.ts
828-
//
829851
// (undocumented)
830852
promptOptions?: LanguageModelPromptOptions;
831853
}
@@ -1032,7 +1054,7 @@ export interface TextPart {
10321054
text: string;
10331055
}
10341056

1035-
// @public (undocumented)
1057+
// @public
10361058
export interface ThinkingConfig {
10371059
thinkingBudget?: number;
10381060
}

‎docs-devsite/_toc.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ toc:
2424
path: /docs/reference/js/ai.booleanschema.md
2525
- title: ChatSession
2626
path: /docs/reference/js/ai.chatsession.md
27+
- title: ChromeAdapter
28+
path: /docs/reference/js/ai.chromeadapter.md
2729
- title: Citation
2830
path: /docs/reference/js/ai.citation.md
2931
- title: CitationMetadata
@@ -120,6 +122,8 @@ toc:
120122
path: /docs/reference/js/ai.languagemodelmessage.md
121123
- title: LanguageModelMessageContent
122124
path: /docs/reference/js/ai.languagemodelmessagecontent.md
125+
- title: LanguageModelPromptOptions
126+
path: /docs/reference/js/ai.languagemodelpromptoptions.md
123127
- title: ModalityTokenCount
124128
path: /docs/reference/js/ai.modalitytokencount.md
125129
- title: ModelParams

‎docs-devsite/ai.chatsession.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Constructs a new instance of the `ChatSession` class
4747
<b>Signature:</b>
4848

4949
```typescript
50-
constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapter, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
50+
constructor(apiSettings: ApiSettings, model: string, chromeAdapter?: ChromeAdapter | undefined, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
5151
```
5252

5353
#### Parameters
@@ -56,7 +56,7 @@ constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapte
5656
| --- | --- | --- |
5757
| apiSettings | ApiSettings | |
5858
| model | string | |
59-
| chromeAdapter | ChromeAdapter | |
59+
| chromeAdapter | [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) \| undefined | |
6060
| params | [StartChatParams](./ai.startchatparams.md#startchatparams_interface) \| undefined | |
6161
| requestOptions | [RequestOptions](./ai.requestoptions.md#requestoptions_interface) \| undefined | |
6262

‎docs-devsite/ai.chromeadapter.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ChromeAdapter interface
13+
Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device is possible.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ChromeAdapter
19+
```
20+
21+
## Methods
22+
23+
| Method | Description |
24+
| --- | --- |
25+
| [countTokens(\_request)](./ai.chromeadapter.md#chromeadaptercounttokens) | |
26+
| [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | |
27+
| [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | |
28+
| [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) | |
29+
30+
## ChromeAdapter.countTokens()
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
countTokens(_request: CountTokensRequest): Promise<Response>;
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| \_request | [CountTokensRequest](./ai.counttokensrequest.md#counttokensrequest_interface) | |
43+
44+
<b>Returns:</b>
45+
46+
Promise&lt;Response&gt;
47+
48+
## ChromeAdapter.generateContent()
49+
50+
<b>Signature:</b>
51+
52+
```typescript
53+
generateContent(request: GenerateContentRequest): Promise<Response>;
54+
```
55+
56+
#### Parameters
57+
58+
| Parameter | Type | Description |
59+
| --- | --- | --- |
60+
| request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | |
61+
62+
<b>Returns:</b>
63+
64+
Promise&lt;Response&gt;
65+
66+
## ChromeAdapter.generateContentStream()
67+
68+
<b>Signature:</b>
69+
70+
```typescript
71+
generateContentStream(request: GenerateContentRequest): Promise<Response>;
72+
```
73+
74+
#### Parameters
75+
76+
| Parameter | Type | Description |
77+
| --- | --- | --- |
78+
| request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | |
79+
80+
<b>Returns:</b>
81+
82+
Promise&lt;Response&gt;
83+
84+
## ChromeAdapter.isAvailable()
85+
86+
<b>Signature:</b>
87+
88+
```typescript
89+
isAvailable(request: GenerateContentRequest): Promise<boolean>;
90+
```
91+
92+
#### Parameters
93+
94+
| Parameter | Type | Description |
95+
| --- | --- | --- |
96+
| request | [GenerateContentRequest](./ai.generatecontentrequest.md#generatecontentrequest_interface) | |
97+
98+
<b>Returns:</b>
99+
100+
Promise&lt;boolean&gt;
101+

‎docs-devsite/ai.generativemodel.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export declare class GenerativeModel extends AIModel
2323
2424
| Constructor | Modifiers | Description |
2525
| --- | --- | --- |
26-
| [(constructor)(ai, modelParams, chromeAdapter, requestOptions)](./ai.generativemodel.md#generativemodelconstructor) | | Constructs a new instance of the <code>GenerativeModel</code> class |
26+
| [(constructor)(ai, modelParams, requestOptions, chromeAdapter)](./ai.generativemodel.md#generativemodelconstructor) | | Constructs a new instance of the <code>GenerativeModel</code> class |
2727
2828
## Properties
2929
@@ -53,7 +53,7 @@ Constructs a new instance of the `GenerativeModel` class
5353
<b>Signature:</b>
5454
5555
```typescript
56-
constructor(ai: AI, modelParams: ModelParams, chromeAdapter: ChromeAdapter, requestOptions?: RequestOptions);
56+
constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions, chromeAdapter?: ChromeAdapter | undefined);
5757
```
5858
5959
#### Parameters
@@ -62,8 +62,8 @@ constructor(ai: AI, modelParams: ModelParams, chromeAdapter: ChromeAdapter, requ
6262
| --- | --- | --- |
6363
| ai | [AI](./ai.ai.md#ai_interface) | |
6464
| modelParams | [ModelParams](./ai.modelparams.md#modelparams_interface) | |
65-
| chromeAdapter | ChromeAdapter | |
6665
| requestOptions | [RequestOptions](./ai.requestoptions.md#requestoptions_interface) | |
66+
| chromeAdapter | [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) \| undefined | |
6767
6868
## GenerativeModel.DEFAULT\_HYBRID\_IN\_CLOUD\_MODEL
6969

‎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-
Toggles hybrid inference.
13+
Configures hybrid inference.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/ai.imagengcsimage.md

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

1212
# ImagenGCSImage interface
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
1316
An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
1417

1518
This feature is not available yet.
@@ -24,11 +27,14 @@ export interface ImagenGCSImage
2427

2528
| Property | Type | Description |
2629
| --- | --- | --- |
27-
| [gcsURI](./ai.imagengcsimage.md#imagengcsimagegcsuri) | string | The URI of the file stored in a Cloud Storage for Firebase bucket. |
28-
| [mimeType](./ai.imagengcsimage.md#imagengcsimagemimetype) | string | The MIME type of the image; either <code>&quot;image/png&quot;</code> or <code>&quot;image/jpeg&quot;</code>.<!-- -->To request a different format, set the <code>imageFormat</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->. |
30+
| [gcsURI](./ai.imagengcsimage.md#imagengcsimagegcsuri) | string | <b><i>(Public Preview)</i></b> The URI of the file stored in a Cloud Storage for Firebase bucket. |
31+
| [mimeType](./ai.imagengcsimage.md#imagengcsimagemimetype) | string | <b><i>(Public Preview)</i></b> The MIME type of the image; either <code>&quot;image/png&quot;</code> or <code>&quot;image/jpeg&quot;</code>.<!-- -->To request a different format, set the <code>imageFormat</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->. |
2932

3033
## ImagenGCSImage.gcsURI
3134

35+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
36+
>
37+
3238
The URI of the file stored in a Cloud Storage for Firebase bucket.
3339

3440
<b>Signature:</b>
@@ -43,6 +49,9 @@ gcsURI: string;
4349

4450
## ImagenGCSImage.mimeType
4551

52+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
53+
>
54+
4655
The MIME type of the image; either `"image/png"` or `"image/jpeg"`<!-- -->.
4756

4857
To request a different format, set the `imageFormat` property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.

‎docs-devsite/ai.languagemodelcreatecoreoptions.md

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

1212
# LanguageModelCreateCoreOptions interface
13+
1314
<b>Signature:</b>
1415

1516
```typescript

‎docs-devsite/ai.languagemodelcreateoptions.md

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

1212
# LanguageModelCreateOptions interface
13+
1314
<b>Signature:</b>
1415

1516
```typescript

‎docs-devsite/ai.languagemodelexpected.md

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

1212
# LanguageModelExpected interface
13+
1314
<b>Signature:</b>
1415

1516
```typescript

0 commit comments

Comments
 (0)