Skip to content

Commit 1e71a56

Browse files
committed
Add missing types
1 parent 66a66b0 commit 1e71a56

File tree

6 files changed

+17
-6
lines changed

6 files changed

+17
-6
lines changed

common/api-review/ai.api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -699,8 +699,6 @@ export type LanguageModelInitialPrompts = LanguageModelMessage[] | LanguageModel
699699
export interface LanguageModelMessage {
700700
// (undocumented)
701701
content: LanguageModelMessageContent[];
702-
// Warning: (ae-forgotten-export) The symbol "LanguageModelMessageRole" needs to be exported by the entry point index.d.ts
703-
//
704702
// (undocumented)
705703
role: LanguageModelMessageRole;
706704
}
@@ -715,6 +713,9 @@ export interface LanguageModelMessageContent {
715713
type: LanguageModelMessageType;
716714
}
717715

716+
// @public (undocumented)
717+
export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
718+
718719
// @public (undocumented)
719720
export interface LanguageModelMessageShorthand {
720721
// (undocumented)

docs-devsite/ai.languagemodelmessage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface LanguageModelMessage
2121
| Property | Type | Description |
2222
| --- | --- | --- |
2323
| [content](./ai.languagemodelmessage.md#languagemodelmessagecontent) | [LanguageModelMessageContent](./ai.languagemodelmessagecontent.md#languagemodelmessagecontent_interface)<!-- -->\[\] | |
24-
| [role](./ai.languagemodelmessage.md#languagemodelmessagerole) | LanguageModelMessageRole | |
24+
| [role](./ai.languagemodelmessage.md#languagemodelmessagerole) | [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | |
2525

2626
## LanguageModelMessage.content
2727

docs-devsite/ai.languagemodelmessageshorthand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface LanguageModelMessageShorthand
2121
| Property | Type | Description |
2222
| --- | --- | --- |
2323
| [content](./ai.languagemodelmessageshorthand.md#languagemodelmessageshorthandcontent) | string | |
24-
| [role](./ai.languagemodelmessageshorthand.md#languagemodelmessageshorthandrole) | LanguageModelMessageRole | |
24+
| [role](./ai.languagemodelmessageshorthand.md#languagemodelmessageshorthandrole) | [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | |
2525

2626
## LanguageModelMessageShorthand.content
2727

docs-devsite/ai.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ The Firebase AI Web SDK.
150150
| [BackendType](./ai.md#backendtype) | Type alias representing valid backend types. It can be either <code>'VERTEX_AI'</code> or <code>'GOOGLE_AI'</code>. |
151151
| [InferenceMode](./ai.md#inferencemode) | Determines whether inference happens on-device or in-cloud. |
152152
| [LanguageModelInitialPrompts](./ai.md#languagemodelinitialprompts) | |
153+
| [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | |
153154
| [LanguageModelMessageType](./ai.md#languagemodelmessagetype) | |
154155
| [Part](./ai.md#part) | Content part - includes text, image/video, or function call/response part types. |
155156
| [ResponseModality](./ai.md#responsemodality) | <b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses. |
@@ -389,6 +390,14 @@ export type InferenceMode = 'prefer_on_device' | 'only_on_device' | 'only_in_clo
389390
export type LanguageModelInitialPrompts = LanguageModelMessage[] | LanguageModelMessageShorthand[];
390391
```
391392

393+
## LanguageModelMessageRole
394+
395+
<b>Signature:</b>
396+
397+
```typescript
398+
export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
399+
```
400+
392401
## LanguageModelMessageType
393402

394403
<b>Signature:</b>

packages/ai/src/types/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export {
3030
LanguageModelInitialPrompts,
3131
LanguageModelMessage,
3232
LanguageModelMessageContent,
33+
LanguageModelMessageRole,
3334
LanguageModelMessageShorthand,
3435
LanguageModelMessageType
3536
} from './language-model';

packages/ai/src/types/language-model.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ export interface LanguageModelMessageContent {
7474
type: LanguageModelMessageType;
7575
content: LanguageModelMessageContentValue;
7676
}
77-
type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
77+
export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
7878
export type LanguageModelMessageType = 'text' | 'image' | 'audio';
79-
type LanguageModelMessageContentValue =
79+
export type LanguageModelMessageContentValue =
8080
| ImageBitmapSource
8181
| AudioBuffer
8282
| BufferSource

0 commit comments

Comments
 (0)