Skip to content

Vaihi add langmodel types. #8927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions packages/vertexai/src/types/language-model.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/**
* @license
* Copyright 2025 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

export interface LanguageModel extends EventTarget {
create(options?: LanguageModelCreateOptions): Promise<LanguageModel>;
availability(options?: LanguageModelCreateCoreOptions): Promise<Availability>;
prompt(
input: LanguageModelPrompt,
options?: LanguageModelPromptOptions
): Promise<string>;
promptStreaming(
input: LanguageModelPrompt,
options?: LanguageModelPromptOptions
): ReadableStream;
measureInputUsage(
input: LanguageModelPrompt,
options?: LanguageModelPromptOptions
): Promise<number>;
destroy(): undefined;
}
enum Availability {
'unavailable',
'downloadable',
'downloading',
'available'
}
interface LanguageModelCreateCoreOptions {
topK?: number;
temperature?: number;
expectedInputs?: LanguageModelExpectedInput[];
}
interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
signal?: AbortSignal;
systemPrompt?: string;
initialPrompts?: LanguageModelInitialPrompts;
}
interface LanguageModelPromptOptions {
signal?: AbortSignal;
}
interface LanguageModelExpectedInput {
type: LanguageModelMessageType;
languages?: string[];
}
type LanguageModelPrompt =
| LanguageModelMessage[]
| LanguageModelMessageShorthand[]
| string;
type LanguageModelInitialPrompts =
| LanguageModelMessage[]
| LanguageModelMessageShorthand[];
interface LanguageModelMessage {
role: LanguageModelMessageRole;
content: LanguageModelMessageContent[];
}
interface LanguageModelMessageShorthand {
role: LanguageModelMessageRole;
content: string;
}
interface LanguageModelMessageContent {
type: LanguageModelMessageType;
content: LanguageModelMessageContentValue;
}
type LanguageModelMessageRole = 'system' | 'user' | 'assistant';
type LanguageModelMessageType = 'text' | 'image' | 'audio';
type LanguageModelMessageContentValue =
| ImageBitmapSource
| AudioBuffer
| BufferSource
| string;
Loading