Skip to content

Commit ff742fe

Browse files
committed
Flatten initial prompts type
1 parent e96b992 commit ff742fe

File tree

3 files changed

+9
-33
lines changed

3 files changed

+9
-33
lines changed

common/api-review/ai.api.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -677,11 +677,9 @@ export interface LanguageModelCreateCoreOptions {
677677
// @public (undocumented)
678678
export interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
679679
// (undocumented)
680-
initialPrompts?: LanguageModelInitialPrompts;
680+
initialPrompts?: LanguageModelMessage[];
681681
// (undocumented)
682682
signal?: AbortSignal;
683-
// (undocumented)
684-
systemPrompt?: string;
685683
}
686684

687685
// @public (undocumented)
@@ -692,9 +690,6 @@ export interface LanguageModelExpectedInput {
692690
type: LanguageModelMessageType;
693691
}
694692

695-
// @public (undocumented)
696-
export type LanguageModelInitialPrompts = LanguageModelMessage[] | LanguageModelMessageShorthand[];
697-
698693
// @public (undocumented)
699694
export interface LanguageModelMessage {
700695
// (undocumented)
@@ -717,14 +712,6 @@ export type LanguageModelMessageContentValue = ImageBitmapSource | AudioBuffer |
717712
// @public (undocumented)
718713
export type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
719714

720-
// @public (undocumented)
721-
export interface LanguageModelMessageShorthand {
722-
// (undocumented)
723-
content: string;
724-
// (undocumented)
725-
role: LanguageModelMessageRole;
726-
}
727-
728715
// @public (undocumented)
729716
export type LanguageModelMessageType = 'text' | 'image' | 'audio';
730717

packages/ai/src/types/index.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,10 @@ export * from './googleai';
2626
export {
2727
LanguageModelCreateOptions,
2828
LanguageModelCreateCoreOptions,
29-
LanguageModelExpectedInput,
30-
LanguageModelInitialPrompts,
29+
LanguageModelExpected,
3130
LanguageModelMessage,
3231
LanguageModelMessageContent,
3332
LanguageModelMessageContentValue,
3433
LanguageModelMessageRole,
35-
LanguageModelMessageShorthand,
3634
LanguageModelMessageType
3735
} from './language-model';

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

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
* limitations under the License.
1616
*/
1717
/**
18-
* {@see https://github.com/webmachinelearning/prompt-api#full-api-surface-in-web-idl}
18+
* The subset of the Prompt API
19+
* ({@see https://github.com/webmachinelearning/prompt-api#full-api-surface-in-web-idl})
20+
* required for hybrid functionality.
1921
*/
2022
export interface LanguageModel extends EventTarget {
2123
create(options?: LanguageModelCreateOptions): Promise<LanguageModel>;
@@ -43,37 +45,26 @@ export enum Availability {
4345
export interface LanguageModelCreateCoreOptions {
4446
topK?: number;
4547
temperature?: number;
46-
expectedInputs?: LanguageModelExpectedInput[];
48+
expectedInputs?: LanguageModelExpected[];
4749
}
4850
export interface LanguageModelCreateOptions
4951
extends LanguageModelCreateCoreOptions {
5052
signal?: AbortSignal;
51-
systemPrompt?: string;
52-
initialPrompts?: LanguageModelInitialPrompts;
53+
initialPrompts?: LanguageModelMessage[];
5354
}
5455
export interface LanguageModelPromptOptions {
5556
responseConstraint?: object;
5657
// TODO: Restore AbortSignal once the API is defined.
5758
}
58-
export interface LanguageModelExpectedInput {
59+
export interface LanguageModelExpected {
5960
type: LanguageModelMessageType;
6061
languages?: string[];
6162
}
62-
export type LanguageModelPrompt =
63-
| LanguageModelMessage[]
64-
| LanguageModelMessageShorthand[]
65-
| string;
66-
export type LanguageModelInitialPrompts =
67-
| LanguageModelMessage[]
68-
| LanguageModelMessageShorthand[];
63+
export type LanguageModelPrompt = LanguageModelMessage[];
6964
export interface LanguageModelMessage {
7065
role: LanguageModelMessageRole;
7166
content: LanguageModelMessageContent[];
7267
}
73-
export interface LanguageModelMessageShorthand {
74-
role: LanguageModelMessageRole;
75-
content: string;
76-
}
7768
export interface LanguageModelMessageContent {
7869
type: LanguageModelMessageType;
7970
value: LanguageModelMessageContentValue;

0 commit comments

Comments
 (0)