modelfusion 0.83.0 → 0.85.0

package/model-provider/openai/chat/OpenAIChatFunctionCallStructureGenerationModel.cjs

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatFunctionCallStructureGenerationModel = void 0;
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const StructureParseError_js_1 = require("../../../model-function/generate-structure/StructureParseError.cjs");
-const OpenAIChatModel_1 = require("./OpenAIChatModel");
+const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
 const OpenAIChatPromptFormat_js_1 = require("./OpenAIChatPromptFormat.cjs");
 class OpenAIChatFunctionCallStructureGenerationModel {
     constructor({ model, fnName, fnDescription, promptFormat, }) {
@@ -101,7 +101,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
         })
             .callAPI(expandedPrompt, {
             ...options,
-            responseFormat: OpenAIChatModel_1.OpenAIChatResponseFormat.json,
+            responseFormat: AbstractOpenAIChatModel_js_1.OpenAIChatResponseFormat.json,
             functionCall: { name: this.fnName },
             functions: [
                 {
@@ -132,7 +132,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
         const expandedPrompt = this.promptFormat.format(prompt);
         return this.model.callAPI(expandedPrompt, {
             ...options,
-            responseFormat: OpenAIChatModel_1.OpenAIChatResponseFormat.structureDeltaIterable,
+            responseFormat: AbstractOpenAIChatModel_js_1.OpenAIChatResponseFormat.structureDeltaIterable,
             functionCall: { name: this.fnName },
             functions: [
                 {

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

@@ -3,9 +3,9 @@ import { JsonSchemaProducer } from "../../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../../core/schema/Schema.js";
 import { StructureGenerationModel } from "../../../model-function/generate-structure/StructureGenerationModel.js";
 import { TextGenerationPromptFormat } from "../../../model-function/generate-text/TextGenerationPromptFormat.js";
-import { OpenAIChatMessage } from "./OpenAIChatMessage";
+import { OpenAIChatPrompt } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatModel, OpenAIChatSettings } from "./OpenAIChatModel";
-export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatMessage[]>> implements StructureGenerationModel<Parameters<PROMPT_FORMAT["format"]>[0], // first argument of the function
+export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatPrompt>> implements StructureGenerationModel<Parameters<PROMPT_FORMAT["format"]>[0], // first argument of the function
 OpenAIChatSettings> {
     readonly model: OpenAIChatModel;
     readonly fnName: string;
@@ -23,16 +23,16 @@ OpenAIChatSettings> {
     /**
      * Returns this model with a text prompt format.
      */
-    withTextPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<string, OpenAIChatMessage[]>>;
+    withTextPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<string, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
     /**
      * Returns this model with an instruction prompt format.
      */
-    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[]>>;
+    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
     /**
      * Returns this model with a chat prompt format.
      */
-    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").ChatPrompt, OpenAIChatMessage[]>>;
-    withPromptFormat<TARGET_PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatMessage[]>>(promptFormat: TARGET_PROMPT_FORMAT): OpenAIChatFunctionCallStructureGenerationModel<TARGET_PROMPT_FORMAT>;
+    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").ChatPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    withPromptFormat<TARGET_PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatPrompt>>(promptFormat: TARGET_PROMPT_FORMAT): OpenAIChatFunctionCallStructureGenerationModel<TARGET_PROMPT_FORMAT>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
     /**
      * JSON generation uses the OpenAI GPT function calling API.
@@ -71,7 +71,7 @@ OpenAIChatSettings> {
                 };
                 index: number;
                 logprobs?: any;
-                finish_reason?: "length" | "stop" | "tool_calls" | "function_call" | "content_filter" | null | undefined;
+                finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
             }[];
             created: number;
             system_fingerprint?: string | undefined;

package/model-provider/openai/chat/OpenAIChatFunctionCallStructureGenerationModel.js

@@ -1,6 +1,6 @@
 import SecureJSON from "secure-json-parse";
 import { StructureParseError } from "../../../model-function/generate-structure/StructureParseError.js";
-import { OpenAIChatResponseFormat, } from "./OpenAIChatModel";
+import { OpenAIChatResponseFormat, } from "./AbstractOpenAIChatModel.js";
 import { chat, instruction, text } from "./OpenAIChatPromptFormat.js";
 export class OpenAIChatFunctionCallStructureGenerationModel {
     constructor({ model, fnName, fnDescription, promptFormat, }) {

package/model-provider/openai/chat/OpenAIChatMessage.cjs

@@ -2,9 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatMessage = void 0;
 exports.OpenAIChatMessage = {
+    /**
+     * Creates a system chat message.
+     */
     system(content) {
         return { role: "system", content };
     },
+    /**
+     * Creates a user chat message. The message can be a string or a multi-modal input.
+     */
     user(content, options) {
         return {
             role: "user",
@@ -27,12 +33,20 @@ exports.OpenAIChatMessage = {
         };
     },
     /**
-     * Creates an assistant chat message. The assistant message can optionally contain tool calls.
+     * Creates an assistant chat message.
+     * The assistant message can optionally contain tool calls
+     * or a function call (function calls are deprecated).
      */
     assistant(content, options) {
         return {
             role: "assistant",
             content,
+            function_call: options?.functionCall == null
+                ? undefined
+                : {
+                    name: options.functionCall.name,
+                    arguments: options.functionCall.arguments,
+                },
             tool_calls: options?.toolCalls?.map((toolCall) => ({
                 id: toolCall.id,
                 type: "function",
@@ -43,6 +57,14 @@ exports.OpenAIChatMessage = {
             })) ?? undefined,
         };
     },
+    /**
+     * Creates a function result chat message for tool call results.
+     *
+     * @deprecated OpenAI functions are deprecated in favor of tools.
+     */
+    fn({ fnName, content, }) {
+        return { role: "function", name: fnName, content: JSON.stringify(content) };
+    },
     /**
      * Creates a tool result chat message with the result of a tool call.
      */

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

@@ -43,15 +43,36 @@ export type OpenAIChatMessage = {
     name: string;
 };
 export declare const OpenAIChatMessage: {
+    /**
+     * Creates a system chat message.
+     */
     system(content: string): OpenAIChatMessage;
+    /**
+     * Creates a user chat message. The message can be a string or a multi-modal input.
+     */
     user(content: string | MultiModalInput, options?: {
         name?: string;
     }): OpenAIChatMessage;
     /**
-     * Creates an assistant chat message. The assistant message can optionally contain tool calls.
+     * Creates an assistant chat message.
+     * The assistant message can optionally contain tool calls
+     * or a function call (function calls are deprecated).
      */
     assistant(content: string | null, options?: {
-        toolCalls: Array<ToolCall<string, unknown>> | null | undefined;
+        functionCall?: {
+            name: string;
+            arguments: string;
+        } | undefined;
+        toolCalls?: Array<ToolCall<string, unknown>> | null | undefined;
+    } | undefined): OpenAIChatMessage;
+    /**
+     * Creates a function result chat message for tool call results.
+     *
+     * @deprecated OpenAI functions are deprecated in favor of tools.
+     */
+    fn({ fnName, content, }: {
+        fnName: string;
+        content: unknown;
     }): OpenAIChatMessage;
     /**
      * Creates a tool result chat message with the result of a tool call.

package/model-provider/openai/chat/OpenAIChatMessage.js

@@ -1,7 +1,13 @@
 export const OpenAIChatMessage = {
+    /**
+     * Creates a system chat message.
+     */
     system(content) {
         return { role: "system", content };
     },
+    /**
+     * Creates a user chat message. The message can be a string or a multi-modal input.
+     */
     user(content, options) {
         return {
             role: "user",
@@ -24,12 +30,20 @@ export const OpenAIChatMessage = {
         };
     },
     /**
-     * Creates an assistant chat message. The assistant message can optionally contain tool calls.
+     * Creates an assistant chat message.
+     * The assistant message can optionally contain tool calls
+     * or a function call (function calls are deprecated).
      */
     assistant(content, options) {
         return {
             role: "assistant",
             content,
+            function_call: options?.functionCall == null
+                ? undefined
+                : {
+                    name: options.functionCall.name,
+                    arguments: options.functionCall.arguments,
+                },
             tool_calls: options?.toolCalls?.map((toolCall) => ({
                 id: toolCall.id,
                 type: "function",
@@ -40,6 +54,14 @@ export const OpenAIChatMessage = {
             })) ?? undefined,
         };
     },
+    /**
+     * Creates a function result chat message for tool call results.
+     *
+     * @deprecated OpenAI functions are deprecated in favor of tools.
+     */
+    fn({ fnName, content, }) {
+        return { role: "function", name: fnName, content: JSON.stringify(content) };
+    },
     /**
      * Creates a tool result chat message with the result of a tool call.
      */

package/model-provider/openai/chat/OpenAIChatModel.cjs

@@ -1,20 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIChatResponseFormat = exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
-const zod_1 = require("zod");
-const callWithRetryAndThrottle_js_1 = require("../../../core/api/callWithRetryAndThrottle.cjs");
-const postToApi_js_1 = require("../../../core/api/postToApi.cjs");
-const parseJSON_js_1 = require("../../../core/schema/parseJSON.cjs");
-const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
+exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
 const StructureFromTextStreamingModel_js_1 = require("../../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
-const parsePartialJson_js_1 = require("../../../model-function/generate-structure/parsePartialJson.cjs");
 const PromptFormatTextStreamingModel_js_1 = require("../../../model-function/generate-text/PromptFormatTextStreamingModel.cjs");
-const OpenAIApiConfiguration_js_1 = require("../OpenAIApiConfiguration.cjs");
-const OpenAIError_js_1 = require("../OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
+const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
 const OpenAIChatFunctionCallStructureGenerationModel_js_1 = require("./OpenAIChatFunctionCallStructureGenerationModel.cjs");
 const OpenAIChatPromptFormat_js_1 = require("./OpenAIChatPromptFormat.cjs");
-const OpenAIChatStreamIterable_js_1 = require("./OpenAIChatStreamIterable.cjs");
 const countOpenAIChatMessageTokens_js_1 = require("./countOpenAIChatMessageTokens.cjs");
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -144,7 +136,7 @@ const calculateOpenAIChatCostInMillicents = ({ model, response, }) => {
 };
 exports.calculateOpenAIChatCostInMillicents = calculateOpenAIChatCostInMillicents;
 /**
- * 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
  *
@@ -162,9 +154,9 @@ exports.calculateOpenAIChatCostInMillicents = calculateOpenAIChatCostInMillicent
  *   ),
  * ]);
  */
-class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
+class OpenAIChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpenAIChatModel {
     constructor(settings) {
-        super({ settings });
+        super(settings);
         Object.defineProperty(this, "provider", {
             enumerable: true,
             configurable: true,
@@ -202,31 +194,6 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             model: this.modelName,
         });
     }
-    async callAPI(messages, options) {
-        return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: this.settings.api?.retry,
-            throttle: this.settings.api?.throttle,
-            call: async () => callOpenAIChatCompletionAPI({
-                ...this.settings,
-                // function & tool calling:
-                functions: options.functions ?? this.settings.functions,
-                functionCall: options.functionCall ?? this.settings.functionCall,
-                tools: options.tools ?? this.settings.tools,
-                toolChoice: options.toolChoice ?? this.settings.toolChoice,
-                // map to OpenAI API names:
-                stop: this.settings.stopSequences,
-                maxTokens: this.settings.maxCompletionTokens,
-                openAIResponseFormat: this.settings.responseFormat,
-                // other settings:
-                user: this.settings.isUserIdForwardingEnabled
-                    ? options.run?.userId
-                    : undefined,
-                abortSignal: options.run?.abortSignal,
-                responseFormat: options.responseFormat,
-                messages,
-            }),
-        });
-    }
     get settingsForEvent() {
         const eventSettingProperties = [
             "stopSequences",
@@ -244,87 +211,6 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
         ];
         return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
     }
-    async doGenerateText(prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: exports.OpenAIChatResponseFormat.json,
-        });
-        return {
-            response,
-            text: response.choices[0].message.content,
-            usage: this.extractUsage(response),
-        };
-    }
-    doStreamText(prompt, options) {
-        return this.callAPI(prompt, {
-            ...options,
-            responseFormat: exports.OpenAIChatResponseFormat.textDeltaIterable,
-        });
-    }
-    async doGenerateToolCall(tool, prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: exports.OpenAIChatResponseFormat.json,
-            toolChoice: {
-                type: "function",
-                function: { name: tool.name },
-            },
-            tools: [
-                {
-                    type: "function",
-                    function: {
-                        name: tool.name,
-                        description: tool.description,
-                        parameters: tool.parameters.getJsonSchema(),
-                    },
-                },
-            ],
-        });
-        const toolCalls = response.choices[0]?.message.tool_calls;
-        return {
-            response,
-            toolCall: toolCalls == null || toolCalls.length === 0
-                ? null
-                : {
-                    id: toolCalls[0].id,
-                    args: (0, parseJSON_js_1.parseJSON)({ text: toolCalls[0].function.arguments }),
-                },
-            usage: this.extractUsage(response),
-        };
-    }
-    async doGenerateToolCallsOrText(tools, prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: exports.OpenAIChatResponseFormat.json,
-            toolChoice: "auto",
-            tools: tools.map((tool) => ({
-                type: "function",
-                function: {
-                    name: tool.name,
-                    description: tool.description,
-                    parameters: tool.parameters.getJsonSchema(),
-                },
-            })),
-        });
-        const message = response.choices[0]?.message;
-        return {
-            response,
-            text: message.content ?? null,
-            toolCalls: message.tool_calls?.map((toolCall) => ({
-                id: toolCall.id,
-                name: toolCall.function.name,
-                args: (0, parseJSON_js_1.parseJSON)({ text: toolCall.function.arguments }),
-            })) ?? null,
-            usage: this.extractUsage(response),
-        };
-    }
-    extractUsage(response) {
-        return {
-            promptTokens: response.usage.prompt_tokens,
-            completionTokens: response.usage.completion_tokens,
-            totalTokens: response.usage.total_tokens,
-        };
-    }
     asFunctionCallStructureGenerationModel({ fnName, fnDescription, }) {
         return new OpenAIChatFunctionCallStructureGenerationModel_js_1.OpenAIChatFunctionCallStructureGenerationModel({
             model: this,
@@ -373,102 +259,3 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
     }
 }
 exports.OpenAIChatModel = OpenAIChatModel;
-const openAIChatResponseSchema = zod_1.z.object({
-    id: zod_1.z.string(),
-    choices: zod_1.z.array(zod_1.z.object({
-        message: zod_1.z.object({
-            role: zod_1.z.literal("assistant"),
-            content: zod_1.z.string().nullable(),
-            function_call: zod_1.z
-                .object({
-                name: zod_1.z.string(),
-                arguments: zod_1.z.string(),
-            })
-                .optional(),
-            tool_calls: zod_1.z
-                .array(zod_1.z.object({
-                id: zod_1.z.string(),
-                type: zod_1.z.literal("function"),
-                function: zod_1.z.object({
-                    name: zod_1.z.string(),
-                    arguments: zod_1.z.string(),
-                }),
-            }))
-                .optional(),
-        }),
-        index: zod_1.z.number(),
-        logprobs: zod_1.z.nullable(zod_1.z.any()),
-        finish_reason: zod_1.z
-            .enum([
-            "stop",
-            "length",
-            "tool_calls",
-            "content_filter",
-            "function_call",
-        ])
-            .optional()
-            .nullable(),
-    })),
-    created: zod_1.z.number(),
-    model: zod_1.z.string(),
-    system_fingerprint: zod_1.z.string().optional(),
-    object: zod_1.z.literal("chat.completion"),
-    usage: zod_1.z.object({
-        prompt_tokens: zod_1.z.number(),
-        completion_tokens: zod_1.z.number(),
-        total_tokens: zod_1.z.number(),
-    }),
-});
-async function callOpenAIChatCompletionAPI({ api = new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration(), abortSignal, responseFormat, model, messages, functions, functionCall, tools, toolChoice, temperature, topP, n, stop, maxTokens, presencePenalty, frequencyPenalty, logitBias, user, openAIResponseFormat, seed, }) {
-    // empty arrays are not allowed for stop:
-    if (stop != null && Array.isArray(stop) && stop.length === 0) {
-        stop = undefined;
-    }
-    return (0, postToApi_js_1.postJsonToApi)({
-        url: api.assembleUrl("/chat/completions"),
-        headers: api.headers,
-        body: {
-            stream: responseFormat.stream,
-            model,
-            messages,
-            functions,
-            function_call: functionCall,
-            tools,
-            tool_choice: toolChoice,
-            temperature,
-            top_p: topP,
-            n,
-            stop,
-            max_tokens: maxTokens,
-            presence_penalty: presencePenalty,
-            frequency_penalty: frequencyPenalty,
-            logit_bias: logitBias,
-            seed,
-            response_format: openAIResponseFormat,
-            user,
-        },
-        failedResponseHandler: OpenAIError_js_1.failedOpenAICallResponseHandler,
-        successfulResponseHandler: responseFormat.handler,
-        abortSignal,
-    });
-}
-exports.OpenAIChatResponseFormat = {
-    /**
-     * Returns the response as a JSON object.
-     */
-    json: {
-        stream: false,
-        handler: (0, postToApi_js_1.createJsonResponseHandler)(openAIChatResponseSchema),
-    },
-    /**
-     * Returns an async iterable over the text deltas (only the tex different of the first choice).
-     */
-    textDeltaIterable: {
-        stream: true,
-        handler: async ({ response }) => (0, OpenAIChatStreamIterable_js_1.createOpenAIChatDeltaIterableQueue)(response.body, (delta) => delta[0]?.delta.content ?? ""),
-    },
-    structureDeltaIterable: {
-        stream: true,
-        handler: async ({ response }) => (0, OpenAIChatStreamIterable_js_1.createOpenAIChatDeltaIterableQueue)(response.body, (delta) => (0, parsePartialJson_js_1.parsePartialJson)(delta[0]?.function_call?.arguments)),
-    },
-};