modelfusion 0.83.0 → 0.84.0

package/model-provider/openai/chat/OpenAIChatModel.d.ts

@@ -1,20 +1,13 @@
-import { z } from "zod";
-import { FunctionOptions } from "../../../core/FunctionOptions.js";
-import { ApiConfiguration } from "../../../core/api/ApiConfiguration.js";
-import { ResponseHandler } from "../../../core/api/postToApi.js";
-import { AbstractModel } from "../../../model-function/AbstractModel.js";
-import { Delta } from "../../../model-function/Delta.js";
 import { StructureFromTextPromptFormat } from "../../../model-function/generate-structure/StructureFromTextPromptFormat.js";
 import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
 import { PromptFormatTextStreamingModel } from "../../../model-function/generate-text/PromptFormatTextStreamingModel.js";
 import { TextGenerationModelSettings, TextStreamingModel } from "../../../model-function/generate-text/TextGenerationModel.js";
 import { TextGenerationPromptFormat } from "../../../model-function/generate-text/TextGenerationPromptFormat.js";
-import { ToolDefinition } from "../../../tool/ToolDefinition.js";
 import { ToolCallGenerationModel } from "../../../tool/generate-tool-call/ToolCallGenerationModel.js";
 import { ToolCallsOrTextGenerationModel } from "../../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
+import { AbstractOpenAIChatCallSettings, AbstractOpenAIChatModel, OpenAIChatPrompt, OpenAIChatResponse } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatFunctionCallStructureGenerationModel } from "./OpenAIChatFunctionCallStructureGenerationModel.js";
-import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 export declare const OPENAI_CHAT_MODELS: {
     "gpt-4": {
         contextWindowSize: number;
@@ -109,49 +102,14 @@ export declare const calculateOpenAIChatCostInMillicents: ({ model, response, }:
     model: OpenAIChatModelType;
     response: OpenAIChatResponse;
 }) => number | null;
-export interface OpenAIChatCallSettings {
-    api?: ApiConfiguration;
+export interface OpenAIChatCallSettings extends AbstractOpenAIChatCallSettings {
     model: OpenAIChatModelType;
-    functions?: Array<{
-        name: string;
-        description?: string;
-        parameters: unknown;
-    }>;
-    functionCall?: "none" | "auto" | {
-        name: string;
-    };
-    tools?: Array<{
-        type: "function";
-        function: {
-            name: string;
-            description?: string;
-            parameters: unknown;
-        };
-    }>;
-    toolChoice?: "none" | "auto" | {
-        type: "function";
-        function: {
-            name: string;
-        };
-    };
-    stop?: string | string[];
-    maxTokens?: number;
-    temperature?: number;
-    topP?: number;
-    seed?: number | null;
-    responseFormat?: {
-        type?: "text" | "json_object";
-    };
-    n?: number;
-    presencePenalty?: number;
-    frequencyPenalty?: number;
-    logitBias?: Record<number, number>;
 }
 export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<OpenAIChatCallSettings, "stop" | "maxTokens"> {
     isUserIdForwardingEnabled?: boolean;
 }
 /**
- * Create a text generation model that calls the OpenAI chat completion API.
+ * Create a text generation model that calls the OpenAI chat API.
  *
  * @see https://platform.openai.com/docs/api-reference/chat/create
  *
@@ -169,7 +127,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<Op
  *   ),
  * ]);
  */
-export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextStreamingModel<OpenAIChatMessage[], OpenAIChatSettings>, ToolCallGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, ToolCallsOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatSettings> {
+export declare class OpenAIChatModel extends AbstractOpenAIChatModel<OpenAIChatSettings> implements TextStreamingModel<OpenAIChatPrompt, OpenAIChatSettings>, ToolCallGenerationModel<OpenAIChatPrompt, OpenAIChatSettings>, ToolCallsOrTextGenerationModel<OpenAIChatPrompt, OpenAIChatSettings> {
     constructor(settings: OpenAIChatSettings);
     readonly provider: "openai";
     get modelName(): OpenAIChatModelType;
@@ -179,433 +137,26 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
      * Counts the prompt tokens required for the messages. This includes the message base tokens
      * and the prompt base tokens.
      */
-    countPromptTokens(messages: OpenAIChatMessage[]): Promise<number>;
-    callAPI<RESULT>(messages: Array<OpenAIChatMessage>, options: {
-        responseFormat: OpenAIChatResponseFormatType<RESULT>;
-    } & FunctionOptions & {
-        functions?: OpenAIChatCallSettings["functions"];
-        functionCall?: OpenAIChatCallSettings["functionCall"];
-        tools?: OpenAIChatCallSettings["tools"];
-        toolChoice?: OpenAIChatCallSettings["toolChoice"];
-    }): Promise<RESULT>;
+    countPromptTokens(messages: OpenAIChatPrompt): Promise<number>;
     get settingsForEvent(): Partial<OpenAIChatSettings>;
-    doGenerateText(prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<{
-        response: {
-            object: "chat.completion";
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-                completion_tokens: number;
-            };
-            model: string;
-            id: string;
-            choices: {
-                message: {
-                    role: "assistant";
-                    content: string | null;
-                    function_call?: {
-                        name: string;
-                        arguments: string;
-                    } | undefined;
-                    tool_calls?: {
-                        function: {
-                            name: string;
-                            arguments: string;
-                        };
-                        type: "function";
-                        id: string;
-                    }[] | undefined;
-                };
-                index: number;
-                logprobs?: any;
-                finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-            }[];
-            created: number;
-            system_fingerprint?: string | undefined;
-        };
-        text: string;
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        };
-    }>;
-    doStreamText(prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
-    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<{
-        response: {
-            object: "chat.completion";
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-                completion_tokens: number;
-            };
-            model: string;
-            id: string;
-            choices: {
-                message: {
-                    role: "assistant";
-                    content: string | null;
-                    function_call?: {
-                        name: string;
-                        arguments: string;
-                    } | undefined;
-                    tool_calls?: {
-                        function: {
-                            name: string;
-                            arguments: string;
-                        };
-                        type: "function";
-                        id: string;
-                    }[] | undefined;
-                };
-                index: number;
-                logprobs?: any;
-                finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-            }[];
-            created: number;
-            system_fingerprint?: string | undefined;
-        };
-        toolCall: {
-            id: string;
-            args: unknown;
-        } | null;
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        };
-    }>;
-    doGenerateToolCallsOrText(tools: Array<ToolDefinition<string, unknown>>, prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<{
-        response: {
-            object: "chat.completion";
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-                completion_tokens: number;
-            };
-            model: string;
-            id: string;
-            choices: {
-                message: {
-                    role: "assistant";
-                    content: string | null;
-                    function_call?: {
-                        name: string;
-                        arguments: string;
-                    } | undefined;
-                    tool_calls?: {
-                        function: {
-                            name: string;
-                            arguments: string;
-                        };
-                        type: "function";
-                        id: string;
-                    }[] | undefined;
-                };
-                index: number;
-                logprobs?: any;
-                finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-            }[];
-            created: number;
-            system_fingerprint?: string | undefined;
-        };
-        text: string | null;
-        toolCalls: {
-            id: string;
-            name: string;
-            args: unknown;
-        }[] | null;
-        usage: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        };
-    }>;
-    extractUsage(response: OpenAIChatResponse): {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
     asFunctionCallStructureGenerationModel({ fnName, fnDescription, }: {
         fnName: string;
         fnDescription?: string;
-    }): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<OpenAIChatMessage[], OpenAIChatMessage[]>>;
-    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, OpenAIChatMessage[]>): StructureFromTextStreamingModel<INPUT_PROMPT, OpenAIChatMessage[], this>;
+    }): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("./OpenAIChatMessage.js").OpenAIChatMessage[], import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): StructureFromTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, this>;
     /**
      * Returns this model with a text prompt format.
      */
-    withTextPrompt(): PromptFormatTextStreamingModel<string, OpenAIChatMessage[], OpenAIChatSettings, this>;
+    withTextPrompt(): PromptFormatTextStreamingModel<string, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
      * Returns this model with an instruction prompt format.
      */
-    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
      * Returns this model with a chat prompt format.
      */
-    withChatPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").ChatPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, OpenAIChatMessage[]>): PromptFormatTextStreamingModel<INPUT_PROMPT, OpenAIChatMessage[], OpenAIChatSettings, this>;
+    withChatPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").ChatPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): PromptFormatTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
 }
-declare const openAIChatResponseSchema: z.ZodObject<{
-    id: z.ZodString;
-    choices: z.ZodArray<z.ZodObject<{
-        message: z.ZodObject<{
-            role: z.ZodLiteral<"assistant">;
-            content: z.ZodNullable<z.ZodString>;
-            function_call: z.ZodOptional<z.ZodObject<{
-                name: z.ZodString;
-                arguments: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                name: string;
-                arguments: string;
-            }, {
-                name: string;
-                arguments: string;
-            }>>;
-            tool_calls: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                id: z.ZodString;
-                type: z.ZodLiteral<"function">;
-                function: z.ZodObject<{
-                    name: z.ZodString;
-                    arguments: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    name: string;
-                    arguments: string;
-                }, {
-                    name: string;
-                    arguments: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }, {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }>, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        }, {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        }>;
-        index: z.ZodNumber;
-        logprobs: z.ZodNullable<z.ZodAny>;
-        finish_reason: z.ZodNullable<z.ZodOptional<z.ZodEnum<["stop", "length", "tool_calls", "content_filter", "function_call"]>>>;
-    }, "strip", z.ZodTypeAny, {
-        message: {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        logprobs?: any;
-        finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-    }, {
-        message: {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        logprobs?: any;
-        finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-    }>, "many">;
-    created: z.ZodNumber;
-    model: z.ZodString;
-    system_fingerprint: z.ZodOptional<z.ZodString>;
-    object: z.ZodLiteral<"chat.completion">;
-    usage: z.ZodObject<{
-        prompt_tokens: z.ZodNumber;
-        completion_tokens: z.ZodNumber;
-        total_tokens: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        prompt_tokens: number;
-        total_tokens: number;
-        completion_tokens: number;
-    }, {
-        prompt_tokens: number;
-        total_tokens: number;
-        completion_tokens: number;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    object: "chat.completion";
-    usage: {
-        prompt_tokens: number;
-        total_tokens: number;
-        completion_tokens: number;
-    };
-    model: string;
-    id: string;
-    choices: {
-        message: {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        logprobs?: any;
-        finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-    }[];
-    created: number;
-    system_fingerprint?: string | undefined;
-}, {
-    object: "chat.completion";
-    usage: {
-        prompt_tokens: number;
-        total_tokens: number;
-        completion_tokens: number;
-    };
-    model: string;
-    id: string;
-    choices: {
-        message: {
-            role: "assistant";
-            content: string | null;
-            function_call?: {
-                name: string;
-                arguments: string;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        logprobs?: any;
-        finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-    }[];
-    created: number;
-    system_fingerprint?: string | undefined;
-}>;
-export type OpenAIChatResponse = z.infer<typeof openAIChatResponseSchema>;
-export type OpenAIChatResponseFormatType<T> = {
-    stream: boolean;
-    handler: ResponseHandler<T>;
-};
-export declare const OpenAIChatResponseFormat: {
-    /**
-     * Returns the response as a JSON object.
-     */
-    json: {
-        stream: false;
-        handler: ResponseHandler<{
-            object: "chat.completion";
-            usage: {
-                prompt_tokens: number;
-                total_tokens: number;
-                completion_tokens: number;
-            };
-            model: string;
-            id: string;
-            choices: {
-                message: {
-                    role: "assistant";
-                    content: string | null;
-                    function_call?: {
-                        name: string;
-                        arguments: string;
-                    } | undefined;
-                    tool_calls?: {
-                        function: {
-                            name: string;
-                            arguments: string;
-                        };
-                        type: "function";
-                        id: string;
-                    }[] | undefined;
-                };
-                index: number;
-                logprobs?: any;
-                finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
-            }[];
-            created: number;
-            system_fingerprint?: string | undefined;
-        }>;
-    };
-    /**
-     * Returns an async iterable over the text deltas (only the tex different of the first choice).
-     */
-    textDeltaIterable: {
-        stream: true;
-        handler: ({ response }: {
-            response: Response;
-        }) => Promise<AsyncIterable<Delta<string>>>;
-    };
-    structureDeltaIterable: {
-        stream: true;
-        handler: ({ response }: {
-            response: Response;
-        }) => Promise<AsyncIterable<Delta<unknown>>>;
-    };
-};
 export {};