@genkit-ai/vertexai
Version:
Genkit AI framework plugin for Google Cloud Vertex AI APIs including Gemini APIs, Imagen, and more.
93 lines (89 loc) • 4.55 kB
text/typescript
import { z, Genkit } from 'genkit';
import { CandidateData, ToolRequestPart, ModelReference, GenerateRequest, ModelAction, Role, MessageData, Part } from 'genkit/model';
import OpenAI from 'openai';
import { ChatCompletion, ChatCompletionChunk, ChatCompletionMessageToolCall, ChatCompletionRole, ChatCompletionMessageParam, ChatCompletionContentPart } from 'openai/resources/index.mjs';
/**
* Copyright 2024 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.
*/
/**
* See https://platform.openai.com/docs/api-reference/chat/create.
* @deprecated
*/
declare const OpenAIConfigSchema: 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>;
}, "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>;
}, 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>;
}, z.ZodTypeAny, "passthrough">>;
/** @deprecated */
declare function toOpenAIRole(role: Role): ChatCompletionRole;
/** @deprecated */
declare function toOpenAiTextAndMedia(part: Part): ChatCompletionContentPart;
/** @deprecated */
declare function toOpenAiMessages(messages: MessageData[]): ChatCompletionMessageParam[];
/** @deprecated */
declare function fromOpenAiToolCall(toolCall: ChatCompletionMessageToolCall | ChatCompletionChunk.Choice.Delta.ToolCall): ToolRequestPart;
/** @deprecated */
declare function fromOpenAiChoice(choice: ChatCompletion.Choice, jsonMode?: boolean): CandidateData;
/** @deprecated */
declare function fromOpenAiChunkChoice(choice: ChatCompletionChunk.Choice, jsonMode?: boolean): CandidateData;
/** @deprecated */
declare function toRequestBody(model: ModelReference<typeof OpenAIConfigSchema>, request: GenerateRequest<typeof OpenAIConfigSchema>): OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming;
/** @deprecated */
declare function openaiCompatibleModel<C extends typeof OpenAIConfigSchema>(ai: Genkit, model: ModelReference<any>, clientFactory: (request: GenerateRequest<C>) => Promise<OpenAI>): ModelAction<C>;
export { OpenAIConfigSchema, fromOpenAiChoice, fromOpenAiChunkChoice, fromOpenAiToolCall, openaiCompatibleModel, toOpenAIRole, toOpenAiMessages, toOpenAiTextAndMedia, toRequestBody };