UNPKG

genkitx-openai

Version:

Firebase Genkit AI framework plugin for OpenAI APIs.

649 lines (645 loc) 27.9 kB
import { CandidateData, GenerateResponseChunkData, ModelInfo, ModelAction } from 'genkit/model'; import { z, ModelReference, Role, Part, MessageData, ToolRequestPart, GenerateRequest, StreamingCallback, GenerateResponseData, Genkit } from 'genkit'; import OpenAI from 'openai'; import { ChatCompletionRole, ChatCompletionContentPart, ChatCompletionMessageParam, ChatCompletionMessageToolCall, ChatCompletionChunk, ChatCompletion } from 'openai/resources/index.mjs'; /** * Copyright 2024 The Fire Company * * 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 OpenAiConfigSchema: z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>; type VisualDetailLevel = z.infer<typeof OpenAiConfigSchema>['visualDetailLevel']; declare const gpt45: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt4o: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const o1Preview: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const o1Mini: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const o1: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const o3Mini: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt4oMini: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt4Turbo: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt4Vision: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt4: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const gpt35Turbo: ModelReference<z.ZodObject<z.objectUtil.extendShape<{ 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">>; }, { 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>; visualDetailLevel: z.ZodOptional<z.ZodEnum<["auto", "low", "high"]>>; }>, "strip", z.ZodTypeAny, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }, { user?: string | undefined; version?: string | undefined; temperature?: number | undefined; maxOutputTokens?: number | undefined; topK?: number | undefined; topP?: number | undefined; stopSequences?: string[] | undefined; frequencyPenalty?: number | undefined; logitBias?: Record<string, number> | undefined; logProbs?: boolean | undefined; presencePenalty?: number | undefined; seed?: number | undefined; topLogProbs?: number | undefined; visualDetailLevel?: "auto" | "low" | "high" | undefined; }>>; declare const SUPPORTED_GPT_MODELS: Record<string, ModelReference<typeof OpenAiConfigSchema>>; declare function toOpenAIRole(role: Role): ChatCompletionRole; /** * Converts a Genkit Part to the corresponding OpenAI ChatCompletionContentPart. * @param part The Genkit Part to convert. * @param visualDetailLevel The visual detail level to use for media parts. * @returns The corresponding OpenAI ChatCompletionContentPart. * @throws Error if the part contains unsupported fields for the current message role. */ declare function toOpenAiTextAndMedia(part: Part, visualDetailLevel: VisualDetailLevel): ChatCompletionContentPart; /** * Converts a Genkit MessageData array to an OpenAI ChatCompletionMessageParam array. * @param messages The Genkit MessageData array to convert. * @param visualDetailLevel The visual detail level to use for media parts. * @returns The converted OpenAI ChatCompletionMessageParam array. */ declare function toOpenAiMessages(messages: MessageData[], visualDetailLevel?: VisualDetailLevel): ChatCompletionMessageParam[]; /** * Converts an OpenAI tool call to a Genkit ToolRequestPart. * @param toolCall The OpenAI tool call to convert. * @returns The converted Genkit ToolRequestPart. */ declare function fromOpenAiToolCall(toolCall: ChatCompletionMessageToolCall | ChatCompletionChunk.Choice.Delta.ToolCall, choice: ChatCompletion.Choice | ChatCompletionChunk.Choice): ToolRequestPart; /** * Converts an OpenAI message event to a Genkit CandidateData object. * @param choice The OpenAI message event to convert. * @param jsonMode Whether the event is a JSON response. * @returns The converted Genkit CandidateData object. */ declare function fromOpenAiChoice(choice: ChatCompletion.Choice, jsonMode?: boolean): CandidateData; /** * Converts an OpenAI message stream event to a Genkit CandidateData object. * @param choice The OpenAI message stream event to convert. * @param jsonMode Whether the event is a JSON response. * @returns The converted Genkit CandidateData object. */ declare function fromOpenAiChunkChoice(choice: ChatCompletionChunk.Choice, jsonMode?: boolean): CandidateData; /** * Converts an OpenAI request to an OpenAI API request body. * @param modelName The name of the OpenAI model to use. * @param request The Genkit GenerateRequest to convert. * @returns The converted OpenAI API request body. * @throws An error if the specified model is not supported or if an unsupported output format is requested. */ declare function toOpenAiRequestBody(modelName: string, request: GenerateRequest<typeof OpenAiConfigSchema>): OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming; /** * Creates the runner used by Genkit to interact with the GPT model. * @param name The name of the GPT model. * @param client The OpenAI client instance. * @returns The runner that Genkit will call when the model is invoked. */ declare function gptRunner(name: string, client: OpenAI): (request: GenerateRequest<typeof OpenAiConfigSchema>, streamingCallback?: StreamingCallback<GenerateResponseChunkData>) => Promise<GenerateResponseData>; /** * Defines a GPT model with the given name and OpenAI client. * @param name The name of the GPT model. * @param client The OpenAI client instance. * @returns The defined GPT model. * @throws An error if the specified model is not supported. */ declare function gptModel(ai: Genkit, name: string, client: OpenAI, modelInfo?: ModelInfo, modelConfig?: any): ModelAction<typeof OpenAiConfigSchema>; export { OpenAiConfigSchema, SUPPORTED_GPT_MODELS, fromOpenAiChoice, fromOpenAiChunkChoice, fromOpenAiToolCall, gpt35Turbo, gpt4, gpt45, gpt4Turbo, gpt4Vision, gpt4o, gpt4oMini, gptModel, gptRunner, o1, o1Mini, o1Preview, o3Mini, toOpenAIRole, toOpenAiMessages, toOpenAiRequestBody, toOpenAiTextAndMedia };