modelfusion 0.69.0 → 0.71.0

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

@@ -383,7 +383,7 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
         const toolCalls = response.choices[0]?.message.tool_calls;
         return {
             response,
-            value: toolCalls == null || toolCalls.length === 0
+            toolCall: toolCalls == null || toolCalls.length === 0
                 ? null
                 : {
                     id: toolCalls[0].id,
@@ -392,6 +392,32 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             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,
+                parameters: (0, parseJSON_js_1.parseJSON)({ text: toolCall.function.arguments }),
+            })) ?? null,
+            usage: this.extractUsage(response),
+        };
+    }
     extractUsage(response) {
         return {
             promptTokens: response.usage.prompt_tokens,
@@ -403,13 +429,13 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
      * Returns this model with an instruction prompt format.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.mapInstructionPromptToOpenAIChatFormat)());
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.instruction)());
     }
     /**
      * Returns this model with a chat prompt format.
      */
     withChatPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.mapChatPromptToOpenAIChatFormat)());
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.chat)());
     }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({

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

@@ -10,8 +10,9 @@ import { StructureOrTextGenerationModel } from "../../../model-function/generate
 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 { ToolCallDefinition } from "../../../model-function/generate-tool-call/ToolCallDefinition.js";
 import { ToolCallGenerationModel } from "../../../model-function/generate-tool-call/ToolCallGenerationModel.js";
+import { ToolCallsOrTextGenerationModel } from "../../../model-function/generate-tool-call/ToolCallsOrTextGenerationModel.js";
+import { ToolDefinition } from "../../../model-function/generate-tool-call/ToolDefinition.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 export declare const OPENAI_CHAT_MODELS: {
@@ -168,7 +169,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<Op
  *   ),
  * ]);
  */
-export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextStreamingModel<OpenAIChatMessage[], OpenAIChatSettings>, StructureGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, ToolCallGenerationModel<OpenAIChatMessage[], OpenAIChatSettings> {
+export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextStreamingModel<OpenAIChatMessage[], OpenAIChatSettings>, StructureGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, ToolCallGenerationModel<OpenAIChatMessage[], OpenAIChatSettings>, ToolCallsOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatSettings> {
     constructor(settings: OpenAIChatSettings);
     readonly provider: "openai";
     get modelName(): OpenAIChatModelType;
@@ -200,8 +201,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;
@@ -249,8 +250,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;
@@ -292,8 +293,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;
@@ -337,8 +338,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;
@@ -371,7 +372,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             totalTokens: number;
         };
     }>;
-    doGenerateToolCall(tool: ToolCallDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<{
+    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: FunctionOptions): Promise<{
         response: {
             object: "chat.completion";
             usage: {
@@ -383,8 +384,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;
@@ -405,7 +406,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             created: number;
             system_fingerprint?: string | undefined;
         };
-        value: {
+        toolCall: {
             id: string;
             parameters: unknown;
         } | null;
@@ -415,6 +416,52 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
             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" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
+            }[];
+            created: number;
+            system_fingerprint?: string | undefined;
+        };
+        text: string | null;
+        toolCalls: {
+            id: string;
+            name: string;
+            parameters: unknown;
+        }[] | null;
+        usage: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        };
+    }>;
     extractUsage(response: OpenAIChatResponse): {
         promptTokens: number;
         completionTokens: number;
@@ -476,8 +523,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
                 id: string;
             }>, "many">>;
         }, "strip", z.ZodTypeAny, {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -491,8 +538,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
                 id: string;
             }[] | undefined;
         }, {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -511,8 +558,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
         finish_reason: z.ZodNullable<z.ZodOptional<z.ZodEnum<["stop", "length", "tool_calls", "content_filter", "function_call"]>>>;
     }, "strip", z.ZodTypeAny, {
         message: {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -531,8 +578,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
         finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
     }, {
         message: {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -578,8 +625,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
     id: string;
     choices: {
         message: {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -610,8 +657,8 @@ declare const openAIChatResponseSchema: z.ZodObject<{
     id: string;
     choices: {
         message: {
-            content: string | null;
             role: "assistant";
+            content: string | null;
             function_call?: {
                 name: string;
                 arguments: string;
@@ -654,8 +701,8 @@ export declare const OpenAIChatResponseFormat: {
             id: string;
             choices: {
                 message: {
-                    content: string | null;
                     role: "assistant";
+                    content: string | null;
                     function_call?: {
                         name: string;
                         arguments: string;

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

@@ -10,7 +10,7 @@ import { PromptFormatTextStreamingModel } from "../../../model-function/generate
 import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
-import { mapChatPromptToOpenAIChatFormat, mapInstructionPromptToOpenAIChatFormat, } from "./OpenAIChatPromptFormat.js";
+import { chat, instruction } from "./OpenAIChatPromptFormat.js";
 import { createOpenAIChatDeltaIterableQueue } from "./OpenAIChatStreamIterable.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
@@ -374,7 +374,7 @@ export class OpenAIChatModel extends AbstractModel {
         const toolCalls = response.choices[0]?.message.tool_calls;
         return {
             response,
-            value: toolCalls == null || toolCalls.length === 0
+            toolCall: toolCalls == null || toolCalls.length === 0
                 ? null
                 : {
                     id: toolCalls[0].id,
@@ -383,6 +383,32 @@ export class OpenAIChatModel extends AbstractModel {
             usage: this.extractUsage(response),
         };
     }
+    async doGenerateToolCallsOrText(tools, prompt, options) {
+        const response = await this.callAPI(prompt, {
+            ...options,
+            responseFormat: 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,
+                parameters: parseJSON({ text: toolCall.function.arguments }),
+            })) ?? null,
+            usage: this.extractUsage(response),
+        };
+    }
     extractUsage(response) {
         return {
             promptTokens: response.usage.prompt_tokens,
@@ -394,13 +420,13 @@ export class OpenAIChatModel extends AbstractModel {
      * Returns this model with an instruction prompt format.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat(mapInstructionPromptToOpenAIChatFormat());
+        return this.withPromptFormat(instruction());
     }
     /**
      * Returns this model with a chat prompt format.
      */
     withChatPrompt() {
-        return this.withPromptFormat(mapChatPromptToOpenAIChatFormat());
+        return this.withPromptFormat(chat());
     }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({

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

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapChatPromptToOpenAIChatFormat = exports.mapInstructionPromptToOpenAIChatFormat = void 0;
+exports.chat = exports.instruction = void 0;
 const validateChatPrompt_js_1 = require("../../../model-function/generate-text/prompt-format/validateChatPrompt.cjs");
 const OpenAIChatMessage_js_1 = require("./OpenAIChatMessage.cjs");
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
-function mapInstructionPromptToOpenAIChatFormat() {
+function instruction() {
     return {
         format: (instruction) => {
             const messages = [];
@@ -24,49 +24,37 @@ function mapInstructionPromptToOpenAIChatFormat() {
         stopSequences: [],
     };
 }
-exports.mapInstructionPromptToOpenAIChatFormat = mapInstructionPromptToOpenAIChatFormat;
+exports.instruction = instruction;
 /**
  * Formats a chat prompt as an OpenAI chat prompt.
  */
-function mapChatPromptToOpenAIChatFormat() {
+function chat() {
     return {
         format: (chatPrompt) => {
             (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
             const messages = [];
-            for (let i = 0; i < chatPrompt.length; i++) {
-                const message = chatPrompt[i];
-                // system message:
-                if (i === 0 &&
-                    "system" in message &&
-                    typeof message.system === "string") {
-                    messages.push({
-                        role: "system",
-                        content: message.system,
-                    });
-                    continue;
-                }
-                // user message
-                if ("user" in message) {
-                    messages.push({
-                        role: "user",
-                        content: message.user,
-                    });
-                    continue;
-                }
-                // ai message:
-                if ("ai" in message) {
-                    messages.push({
-                        role: "assistant",
-                        content: message.ai,
-                    });
-                    continue;
+            if (chatPrompt.system != null) {
+                messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.system(chatPrompt.system));
+            }
+            for (const { role, content } of chatPrompt.messages) {
+                switch (role) {
+                    case "user": {
+                        messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.user(content));
+                        break;
+                    }
+                    case "assistant": {
+                        messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.assistant(content));
+                        break;
+                    }
+                    default: {
+                        const _exhaustiveCheck = role;
+                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                    }
                 }
-                // unsupported message:
-                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
             }
             return messages;
         },
         stopSequences: [],
     };
 }
-exports.mapChatPromptToOpenAIChatFormat = mapChatPromptToOpenAIChatFormat;
+exports.chat = chat;

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

@@ -5,8 +5,8 @@ import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
-export declare function mapInstructionPromptToOpenAIChatFormat(): TextGenerationPromptFormat<InstructionPrompt, Array<OpenAIChatMessage>>;
+export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt, Array<OpenAIChatMessage>>;
 /**
  * Formats a chat prompt as an OpenAI chat prompt.
  */
-export declare function mapChatPromptToOpenAIChatFormat(): TextGenerationPromptFormat<ChatPrompt, Array<OpenAIChatMessage>>;
+export declare function chat(): TextGenerationPromptFormat<ChatPrompt, Array<OpenAIChatMessage>>;

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

@@ -3,7 +3,7 @@ import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
-export function mapInstructionPromptToOpenAIChatFormat() {
+export function instruction() {
     return {
         format: (instruction) => {
             const messages = [];
@@ -24,41 +24,29 @@ export function mapInstructionPromptToOpenAIChatFormat() {
 /**
  * Formats a chat prompt as an OpenAI chat prompt.
  */
-export function mapChatPromptToOpenAIChatFormat() {
+export function chat() {
     return {
         format: (chatPrompt) => {
             validateChatPrompt(chatPrompt);
             const messages = [];
-            for (let i = 0; i < chatPrompt.length; i++) {
-                const message = chatPrompt[i];
-                // system message:
-                if (i === 0 &&
-                    "system" in message &&
-                    typeof message.system === "string") {
-                    messages.push({
-                        role: "system",
-                        content: message.system,
-                    });
-                    continue;
-                }
-                // user message
-                if ("user" in message) {
-                    messages.push({
-                        role: "user",
-                        content: message.user,
-                    });
-                    continue;
-                }
-                // ai message:
-                if ("ai" in message) {
-                    messages.push({
-                        role: "assistant",
-                        content: message.ai,
-                    });
-                    continue;
+            if (chatPrompt.system != null) {
+                messages.push(OpenAIChatMessage.system(chatPrompt.system));
+            }
+            for (const { role, content } of chatPrompt.messages) {
+                switch (role) {
+                    case "user": {
+                        messages.push(OpenAIChatMessage.user(content));
+                        break;
+                    }
+                    case "assistant": {
+                        messages.push(OpenAIChatMessage.assistant(content));
+                        break;
+                    }
+                    default: {
+                        const _exhaustiveCheck = role;
+                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                    }
                 }
-                // unsupported message:
-                throw new Error(`Unsupported message: ${JSON.stringify(message)}`);
             }
             return messages;
         },

package/model-provider/openai/index.cjs

@@ -10,11 +10,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIError = void 0;
+exports.OpenAIChatPromptFormat = exports.OpenAIError = void 0;
 __exportStar(require("./AzureOpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAICompletionModel.cjs"), exports);
@@ -28,5 +40,5 @@ __exportStar(require("./OpenAITranscriptionModel.cjs"), exports);
 __exportStar(require("./TikTokenTokenizer.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatMessage.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatModel.cjs"), exports);
-__exportStar(require("./chat/OpenAIChatPromptFormat.cjs"), exports);
+exports.OpenAIChatPromptFormat = __importStar(require("./chat/OpenAIChatPromptFormat.cjs"));
 __exportStar(require("./chat/countOpenAIChatMessageTokens.cjs"), exports);

package/model-provider/openai/index.d.ts

@@ -10,6 +10,6 @@ export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export * from "./chat/OpenAIChatPromptFormat.js";
+export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";
 export { OpenAIChatDelta } from "./chat/OpenAIChatStreamIterable.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/model-provider/openai/index.js

@@ -10,5 +10,5 @@ export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export * from "./chat/OpenAIChatPromptFormat.js";
+export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
-  "description": "Build multimodal applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.69.0",
+  "description": "The TypeScript library for building multi-modal AI applications.",
+  "version": "0.71.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/tool/Tool.cjs

@@ -71,7 +71,7 @@ class Tool {
         this.execute = execute;
     }
     /**
-     * Provdes a structure definition with the name, description and schema of the input.
+     * Provides a structure definition with the name, description and schema of the input.
      * This is used by `useTool`.
      */
     get inputStructureDefinition() {

package/tool/Tool.d.ts

@@ -38,7 +38,7 @@ export declare class Tool<NAME extends string, INPUT, OUTPUT> {
         execute(input: INPUT, options?: FunctionOptions): PromiseLike<OUTPUT>;
     });
     /**
-     * Provdes a structure definition with the name, description and schema of the input.
+     * Provides a structure definition with the name, description and schema of the input.
      * This is used by `useTool`.
      */
     get inputStructureDefinition(): StructureDefinition<NAME, INPUT>;

package/tool/Tool.js

@@ -68,7 +68,7 @@ export class Tool {
         this.execute = execute;
     }
     /**
-     * Provdes a structure definition with the name, description and schema of the input.
+     * Provides a structure definition with the name, description and schema of the input.
      * This is used by `useTool`.
      */
     get inputStructureDefinition() {