Skip to content

Commit 50f142a

Browse files
erikeldridgeerikeldridge
authored
VinF Hybrid Inference: Document exported LanguageModel types (#9035)
1 parent c16cbf1 commit 50f142a

13 files changed

+399
-12
lines changed

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

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -664,6 +664,70 @@ export class IntegerSchema extends Schema {
664664
constructor(schemaParams?: SchemaParams);
665665
}
666666

667+
// @public (undocumented)
668+
export interface LanguageModelCreateCoreOptions {
669+
// (undocumented)
670+
expectedInputs?: LanguageModelExpectedInput[];
671+
// (undocumented)
672+
temperature?: number;
673+
// (undocumented)
674+
topK?: number;
675+
}
676+
677+
// @public (undocumented)
678+
export interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
679+
// (undocumented)
680+
initialPrompts?: LanguageModelInitialPrompts;
681+
// (undocumented)
682+
signal?: AbortSignal;
683+
// (undocumented)
684+
systemPrompt?: string;
685+
}
686+
687+
// @public (undocumented)
688+
export interface LanguageModelExpectedInput {
689+
// (undocumented)
690+
languages?: string[];
691+
// (undocumented)
692+
type: LanguageModelMessageType;
693+
}
694+
695+
// @public (undocumented)
696+
export type LanguageModelInitialPrompts = LanguageModelMessage[] | LanguageModelMessageShorthand[];
697+
698+
// @public (undocumented)
699+
export interface LanguageModelMessage {
700+
// (undocumented)
701+
content: LanguageModelMessageContent[];
702+
// (undocumented)
703+
role: LanguageModelMessageRole;
704+
}
705+
706+
// @public (undocumented)
707+
export interface LanguageModelMessageContent {
708+
// (undocumented)
709+
content: LanguageModelMessageContentValue;
710+
// (undocumented)
711+
type: LanguageModelMessageType;
712+
}
713+
714+
// @public (undocumented)
715+
export type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer | BufferSource | string;
716+
717+
// @public (undocumented)
718+
export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
719+
720+
// @public (undocumented)
721+
export interface LanguageModelMessageShorthand {
722+
// (undocumented)
723+
content: string;
724+
// (undocumented)
725+
role: LanguageModelMessageRole;
726+
}
727+
728+
// @public (undocumented)
729+
export type LanguageModelMessageType = 'text' | 'image' | 'audio';
730+
667731
// @public
668732
export enum Modality {
669733
AUDIO = "AUDIO",
@@ -722,8 +786,6 @@ export interface ObjectSchemaInterface extends SchemaInterface {
722786

723787
// @public
724788
export interface OnDeviceParams {
725-
// Warning: (ae-forgotten-export) The symbol "LanguageModelCreateOptions" needs to be exported by the entry point index.d.ts
726-
//
727789
// (undocumented)
728790
createOptions?: LanguageModelCreateOptions;
729791
// Warning: (ae-forgotten-export) The symbol "LanguageModelPromptOptions" needs to be exported by the entry point index.d.ts

‎docs-devsite/_toc.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,18 @@ toc:
102102
path: /docs/reference/js/ai.inlinedatapart.md
103103
- title: IntegerSchema
104104
path: /docs/reference/js/ai.integerschema.md
105+
- title: LanguageModelCreateCoreOptions
106+
path: /docs/reference/js/ai.languagemodelcreatecoreoptions.md
107+
- title: LanguageModelCreateOptions
108+
path: /docs/reference/js/ai.languagemodelcreateoptions.md
109+
- title: LanguageModelExpectedInput
110+
path: /docs/reference/js/ai.languagemodelexpectedinput.md
111+
- title: LanguageModelMessage
112+
path: /docs/reference/js/ai.languagemodelmessage.md
113+
- title: LanguageModelMessageContent
114+
path: /docs/reference/js/ai.languagemodelmessagecontent.md
115+
- title: LanguageModelMessageShorthand
116+
path: /docs/reference/js/ai.languagemodelmessageshorthand.md
105117
- title: ModalityTokenCount
106118
path: /docs/reference/js/ai.modalitytokencount.md
107119
- title: ModelParams

‎docs-devsite/ai.languagemodelcreatecoreoptions.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
# LanguageModelCreateCoreOptions interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelCreateCoreOptions
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [expectedInputs](./ai.languagemodelcreatecoreoptions.md#languagemodelcreatecoreoptionsexpectedinputs) | [LanguageModelExpectedInput](./ai.languagemodelexpectedinput.md#languagemodelexpectedinput_interface)<!-- -->\[\] | |
24+
| [temperature](./ai.languagemodelcreatecoreoptions.md#languagemodelcreatecoreoptionstemperature) | number | |
25+
| [topK](./ai.languagemodelcreatecoreoptions.md#languagemodelcreatecoreoptionstopk) | number | |
26+
27+
## LanguageModelCreateCoreOptions.expectedInputs
28+
29+
<b>Signature:</b>
30+
31+
```typescript
32+
expectedInputs?: LanguageModelExpectedInput[];
33+
```
34+
35+
## LanguageModelCreateCoreOptions.temperature
36+
37+
<b>Signature:</b>
38+
39+
```typescript
40+
temperature?: number;
41+
```
42+
43+
## LanguageModelCreateCoreOptions.topK
44+
45+
<b>Signature:</b>
46+
47+
```typescript
48+
topK?: number;
49+
```

‎docs-devsite/ai.languagemodelcreateoptions.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
# LanguageModelCreateOptions interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions
17+
```
18+
<b>Extends:</b> [LanguageModelCreateCoreOptions](./ai.languagemodelcreatecoreoptions.md#languagemodelcreatecoreoptions_interface)
19+
20+
## Properties
21+
22+
| Property | Type | Description |
23+
| --- | --- | --- |
24+
| [initialPrompts](./ai.languagemodelcreateoptions.md#languagemodelcreateoptionsinitialprompts) | [LanguageModelInitialPrompts](./ai.md#languagemodelinitialprompts) | |
25+
| [signal](./ai.languagemodelcreateoptions.md#languagemodelcreateoptionssignal) | AbortSignal | |
26+
| [systemPrompt](./ai.languagemodelcreateoptions.md#languagemodelcreateoptionssystemprompt) | string | |
27+
28+
## LanguageModelCreateOptions.initialPrompts
29+
30+
<b>Signature:</b>
31+
32+
```typescript
33+
initialPrompts?: LanguageModelInitialPrompts;
34+
```
35+
36+
## LanguageModelCreateOptions.signal
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
signal?: AbortSignal;
42+
```
43+
44+
## LanguageModelCreateOptions.systemPrompt
45+
46+
<b>Signature:</b>
47+
48+
```typescript
49+
systemPrompt?: string;
50+
```

‎docs-devsite/ai.languagemodelexpectedinput.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
# LanguageModelExpectedInput interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelExpectedInput
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [languages](./ai.languagemodelexpectedinput.md#languagemodelexpectedinputlanguages) | string\[\] | |
24+
| [type](./ai.languagemodelexpectedinput.md#languagemodelexpectedinputtype) | [LanguageModelMessageType](./ai.md#languagemodelmessagetype) | |
25+
26+
## LanguageModelExpectedInput.languages
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
languages?: string[];
32+
```
33+
34+
## LanguageModelExpectedInput.type
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
type: LanguageModelMessageType;
40+
```

‎docs-devsite/ai.languagemodelmessage.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
# LanguageModelMessage interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelMessage
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [content](./ai.languagemodelmessage.md#languagemodelmessagecontent) | [LanguageModelMessageContent](./ai.languagemodelmessagecontent.md#languagemodelmessagecontent_interface)<!-- -->\[\] | |
24+
| [role](./ai.languagemodelmessage.md#languagemodelmessagerole) | [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | |
25+
26+
## LanguageModelMessage.content
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
content: LanguageModelMessageContent[];
32+
```
33+
34+
## LanguageModelMessage.role
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
role: LanguageModelMessageRole;
40+
```

‎docs-devsite/ai.languagemodelmessagecontent.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
# LanguageModelMessageContent interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelMessageContent
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [content](./ai.languagemodelmessagecontent.md#languagemodelmessagecontentcontent) | [LanguageModelMessageContentValue](./ai.md#languagemodelmessagecontentvalue) | |
24+
| [type](./ai.languagemodelmessagecontent.md#languagemodelmessagecontenttype) | [LanguageModelMessageType](./ai.md#languagemodelmessagetype) | |
25+
26+
## LanguageModelMessageContent.content
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
content: LanguageModelMessageContentValue;
32+
```
33+
34+
## LanguageModelMessageContent.type
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
type: LanguageModelMessageType;
40+
```

‎docs-devsite/ai.languagemodelmessageshorthand.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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+
# LanguageModelMessageShorthand interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export interface LanguageModelMessageShorthand
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [content](./ai.languagemodelmessageshorthand.md#languagemodelmessageshorthandcontent) | string | |
24+
| [role](./ai.languagemodelmessageshorthand.md#languagemodelmessageshorthandrole) | [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | |
25+
26+
## LanguageModelMessageShorthand.content
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
content: string;
32+
```
33+
34+
## LanguageModelMessageShorthand.role
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
role: LanguageModelMessageRole;
40+
```

0 commit comments

Comments
 (0)