@genkit-ai/vertexai
Version:
Genkit AI framework plugin for Google Cloud Vertex AI APIs including Gemini APIs, Imagen, and more.
372 lines (368 loc) • 16.5 kB
text/typescript
import { ModelReference, z, ActionMetadata } from 'genkit';
import { ModelAction } from 'genkit/model';
import { GoogleAuth } from 'google-auth-library';
import { PluginOptions } from './types.mjs';
import '../../types-B3i-Lt7D.mjs';
import '@google-cloud/vertexai';
/**
* 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.
*/
declare const LlamaConfigSchema: z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>;
type LlamaConfigSchemaType = typeof LlamaConfigSchema;
type LlamaConfig = z.infer<LlamaConfigSchemaType>;
declare const GENERIC_MODEL: ModelReference<z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>>;
declare const KNOWN_MODELS: {
'meta/llama-4-maverick-17b-128e-instruct-maas': ModelReference<z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>>;
'meta/llama-4-scout-17b-16e-instruct-maas': ModelReference<z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>>;
'meta/llama-3.3-70b-instruct-maas': ModelReference<z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>>;
};
type KnownModels = keyof typeof KNOWN_MODELS;
type LlamaModelName = `meta/llama-${string}`;
declare function isLlamaModelName(value?: string): value is LlamaModelName;
declare function model(version: string, options?: LlamaConfig): ModelReference<LlamaConfigSchemaType>;
interface ClientOptions {
location: string;
projectId: string;
authClient: GoogleAuth;
baseUrlTemplate?: string;
}
declare function listActions(clientOptions: ClientOptions): ActionMetadata[];
declare function listKnownModels(clientOptions: ClientOptions, pluginOptions?: PluginOptions): ModelAction<z.ZodObject<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
version: z.ZodOptional<z.ZodString>;
temperature: z.ZodOptional<z.ZodNumber>;
maxOutputTokens: z.ZodOptional<z.ZodNumber>;
topK: z.ZodOptional<z.ZodNumber>;
topP: z.ZodOptional<z.ZodNumber>;
stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
apiKey: z.ZodOptional<z.ZodString>;
} & {
frequencyPenalty: z.ZodOptional<z.ZodNumber>;
logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
logProbs: z.ZodOptional<z.ZodBoolean>;
presencePenalty: z.ZodOptional<z.ZodNumber>;
seed: z.ZodOptional<z.ZodNumber>;
topLogProbs: z.ZodOptional<z.ZodNumber>;
user: z.ZodOptional<z.ZodString>;
} & {
location: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>>[];
declare function defineModel(name: string, clientOptions: ClientOptions, pluginOptions?: PluginOptions): ModelAction<LlamaConfigSchemaType>;
export { type ClientOptions, GENERIC_MODEL, KNOWN_MODELS, type KnownModels, type LlamaConfig, LlamaConfigSchema, type LlamaConfigSchemaType, type LlamaModelName, defineModel, isLlamaModelName, listActions, listKnownModels, model };