modelfusion 0.133.0 → 0.134.0

package/model-provider/openai/OpenAIChatFunctionCallObjectGenerationModel.js

@@ -1,162 +0,0 @@
-import SecureJSON from "secure-json-parse";
-import { ObjectParseError } from "../../model-function/generate-object/ObjectParseError.js";
-import { parsePartialJson } from "../../util/parsePartialJson.js";
-import { OpenAIChatResponseFormat, } from "./AbstractOpenAIChatModel.js";
-import { chat, instruction, text } from "./OpenAIChatPromptTemplate.js";
-export class OpenAIChatFunctionCallObjectGenerationModel {
-    constructor({ model, fnName, fnDescription, promptTemplate, }) {
-        Object.defineProperty(this, "model", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "fnName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "fnDescription", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "promptTemplate", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.model = model;
-        this.fnName = fnName;
-        this.fnDescription = fnDescription;
-        this.promptTemplate = promptTemplate;
-    }
-    get modelInformation() {
-        return this.model.modelInformation;
-    }
-    get settings() {
-        return {
-            ...this.model.settings,
-            fnName: this.fnName,
-            fnDescription: this.fnDescription,
-        };
-    }
-    get settingsForEvent() {
-        return {
-            ...this.model.settingsForEvent,
-            fnName: this.fnName,
-            fnDescription: this.fnDescription,
-        };
-    }
-    /**
-     * Returns this model with a text prompt template.
-     */
-    withTextPrompt() {
-        return this.withPromptTemplate(text());
-    }
-    /**
-     * Returns this model with an instruction prompt template.
-     */
-    withInstructionPrompt() {
-        return this.withPromptTemplate(instruction());
-    }
-    /**
-     * Returns this model with a chat prompt template.
-     */
-    withChatPrompt() {
-        return this.withPromptTemplate(chat());
-    }
-    withPromptTemplate(promptTemplate) {
-        return new OpenAIChatFunctionCallObjectGenerationModel({
-            model: this.model,
-            fnName: this.fnName,
-            fnDescription: this.fnDescription,
-            promptTemplate,
-        });
-    }
-    withSettings(additionalSettings) {
-        return new OpenAIChatFunctionCallObjectGenerationModel({
-            model: this.model.withSettings(additionalSettings),
-            fnName: this.fnName,
-            fnDescription: this.fnDescription,
-            promptTemplate: this.promptTemplate,
-        });
-    }
-    /**
-     * JSON generation uses the OpenAI GPT function calling API.
-     * It provides a single function specification and instructs the model to provide parameters for calling the function.
-     * The result is returned as parsed JSON.
-     *
-     * @see https://platform.openai.com/docs/guides/gpt/function-calling
-     */
-    async doGenerateObject(schema, prompt, // first argument of the function
-    options) {
-        const expandedPrompt = this.promptTemplate.format(prompt);
-        const rawResponse = await this.model
-            .withSettings({
-            stopSequences: [
-                ...(this.settings.stopSequences ?? []),
-                ...this.promptTemplate.stopSequences,
-            ],
-        })
-            .callAPI(expandedPrompt, options, {
-            responseFormat: OpenAIChatResponseFormat.json,
-            functionCall: { name: this.fnName },
-            functions: [
-                {
-                    name: this.fnName,
-                    description: this.fnDescription,
-                    parameters: schema.getJsonSchema(),
-                },
-            ],
-        });
-        const valueText = rawResponse.choices[0].message.function_call.arguments;
-        try {
-            return {
-                rawResponse,
-                valueText,
-                value: SecureJSON.parse(valueText),
-                usage: this.model.extractUsage(rawResponse),
-            };
-        }
-        catch (error) {
-            throw new ObjectParseError({
-                valueText,
-                cause: error,
-            });
-        }
-    }
-    async doStreamObject(schema, prompt, // first argument of the function
-    options) {
-        const expandedPrompt = this.promptTemplate.format(prompt);
-        return this.model.callAPI(expandedPrompt, options, {
-            responseFormat: OpenAIChatResponseFormat.deltaIterable,
-            functionCall: { name: this.fnName },
-            functions: [
-                {
-                    name: this.fnName,
-                    description: this.fnDescription,
-                    parameters: schema.getJsonSchema(),
-                },
-            ],
-        });
-    }
-    extractObjectTextDelta(delta) {
-        const chunk = delta;
-        if (chunk.object !== "chat.completion.chunk") {
-            return undefined;
-        }
-        const chatChunk = chunk;
-        const firstChoice = chatChunk.choices[0];
-        if (firstChoice.index > 0) {
-            return undefined;
-        }
-        return firstChoice.delta.function_call?.arguments;
-    }
-    parseAccumulatedObjectText(accumulatedText) {
-        return parsePartialJson(accumulatedText);
-    }
-}

package/model-provider/openai/OpenAIChatMessage.cjs

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIChatMessage = void 0;
-const DataContent_js_1 = require("../../util/format/DataContent.cjs");
-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",
-            content: typeof content === "string"
-                ? content
-                : content.map((part) => {
-                    switch (part.type) {
-                        case "text": {
-                            return { type: "text", text: part.text };
-                        }
-                        case "image": {
-                            return {
-                                type: "image_url",
-                                image_url: `data:${part.mimeType ?? "image/jpeg"};base64,${(0, DataContent_js_1.convertDataContentToBase64String)(part.image)}`,
-                            };
-                        }
-                    }
-                }),
-            name: options?.name,
-        };
-    },
-    /**
-     * 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",
-                function: {
-                    name: toolCall.name,
-                    arguments: JSON.stringify(toolCall.args),
-                },
-            })) ?? 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.
-     */
-    tool({ toolCallId, content, }) {
-        return {
-            role: "tool",
-            tool_call_id: toolCallId,
-            content: JSON.stringify(content),
-        };
-    },
-};

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

@@ -1,84 +0,0 @@
-import { ImagePart, TextPart } from "../../model-function/generate-text/prompt-template/ContentPart.js";
-import { ToolCall } from "../../tool/ToolCall.js";
-export type OpenAIChatMessage = {
-    role: "system";
-    content: string;
-    name?: string;
-} | {
-    role: "user";
-    content: string | Array<{
-        type: "text";
-        text: string;
-    } | {
-        type: "image_url";
-        image_url: string | {
-            url: string;
-            detail: "low" | "high" | "auto";
-        };
-    }>;
-    name?: string;
-} | {
-    role: "assistant";
-    content: string | null;
-    name?: string;
-    tool_calls?: Array<{
-        id: string;
-        type: "function";
-        function: {
-            name: string;
-            arguments: string;
-        };
-    }>;
-    function_call?: {
-        name: string;
-        arguments: string;
-    };
-} | {
-    role: "tool";
-    tool_call_id: string;
-    content: string | null;
-} | {
-    role: "function";
-    content: string;
-    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 | Array<TextPart | ImagePart>, options?: {
-        name?: string;
-    }): OpenAIChatMessage;
-    /**
-     * 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?: {
-        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.
-     */
-    tool({ toolCallId, content, }: {
-        toolCallId: string;
-        content: unknown;
-    }): OpenAIChatMessage;
-};

package/model-provider/openai/OpenAIChatMessage.js

@@ -1,76 +0,0 @@
-import { convertDataContentToBase64String } from "../../util/format/DataContent.js";
-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",
-            content: typeof content === "string"
-                ? content
-                : content.map((part) => {
-                    switch (part.type) {
-                        case "text": {
-                            return { type: "text", text: part.text };
-                        }
-                        case "image": {
-                            return {
-                                type: "image_url",
-                                image_url: `data:${part.mimeType ?? "image/jpeg"};base64,${convertDataContentToBase64String(part.image)}`,
-                            };
-                        }
-                    }
-                }),
-            name: options?.name,
-        };
-    },
-    /**
-     * 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",
-                function: {
-                    name: toolCall.name,
-                    arguments: JSON.stringify(toolCall.args),
-                },
-            })) ?? 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.
-     */
-    tool({ toolCallId, content, }) {
-        return {
-            role: "tool",
-            tool_call_id: toolCallId,
-            content: JSON.stringify(content),
-        };
-    },
-};

package/model-provider/openai/OpenAIChatModel.cjs

@@ -1,274 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
-const ObjectFromTextStreamingModel_js_1 = require("../../model-function/generate-object/ObjectFromTextStreamingModel.cjs");
-const PromptTemplateFullTextModel_js_1 = require("../../model-function/generate-text/PromptTemplateFullTextModel.cjs");
-const TextGenerationModel_js_1 = require("../../model-function/generate-text/TextGenerationModel.cjs");
-const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
-const OpenAIChatFunctionCallObjectGenerationModel_js_1 = require("./OpenAIChatFunctionCallObjectGenerationModel.cjs");
-const OpenAIChatPromptTemplate_js_1 = require("./OpenAIChatPromptTemplate.cjs");
-const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
-const countOpenAIChatMessageTokens_js_1 = require("./countOpenAIChatMessageTokens.cjs");
-/*
- * Available OpenAI chat models, their token limits, and pricing.
- *
- * @see https://platform.openai.com/docs/models/
- * @see https://openai.com/pricing
- */
-exports.OPENAI_CHAT_MODELS = {
-    "gpt-4": {
-        contextWindowSize: 8192,
-        promptTokenCostInMillicents: 3,
-        completionTokenCostInMillicents: 6,
-    },
-    "gpt-4-0314": {
-        contextWindowSize: 8192,
-        promptTokenCostInMillicents: 3,
-        completionTokenCostInMillicents: 6,
-    },
-    "gpt-4-0613": {
-        contextWindowSize: 8192,
-        promptTokenCostInMillicents: 3,
-        completionTokenCostInMillicents: 6,
-        fineTunedPromptTokenCostInMillicents: null,
-        fineTunedCompletionTokenCostInMillicents: null,
-    },
-    "gpt-4-turbo-preview": {
-        contextWindowSize: 128000,
-        promptTokenCostInMillicents: 1,
-        completionTokenCostInMillicents: 3,
-    },
-    "gpt-4-1106-preview": {
-        contextWindowSize: 128000,
-        promptTokenCostInMillicents: 1,
-        completionTokenCostInMillicents: 3,
-    },
-    "gpt-4-0125-preview": {
-        contextWindowSize: 128000,
-        promptTokenCostInMillicents: 1,
-        completionTokenCostInMillicents: 3,
-    },
-    "gpt-4-vision-preview": {
-        contextWindowSize: 128000,
-        promptTokenCostInMillicents: 1,
-        completionTokenCostInMillicents: 3,
-    },
-    "gpt-4-32k": {
-        contextWindowSize: 32768,
-        promptTokenCostInMillicents: 6,
-        completionTokenCostInMillicents: 12,
-    },
-    "gpt-4-32k-0314": {
-        contextWindowSize: 32768,
-        promptTokenCostInMillicents: 6,
-        completionTokenCostInMillicents: 12,
-    },
-    "gpt-4-32k-0613": {
-        contextWindowSize: 32768,
-        promptTokenCostInMillicents: 6,
-        completionTokenCostInMillicents: 12,
-    },
-    "gpt-3.5-turbo": {
-        contextWindowSize: 4096,
-        promptTokenCostInMillicents: 0.15,
-        completionTokenCostInMillicents: 0.2,
-        fineTunedPromptTokenCostInMillicents: 0.3,
-        fineTunedCompletionTokenCostInMillicents: 0.6,
-    },
-    "gpt-3.5-turbo-0125": {
-        contextWindowSize: 16385,
-        promptTokenCostInMillicents: 0.05,
-        completionTokenCostInMillicents: 0.15,
-    },
-    "gpt-3.5-turbo-1106": {
-        contextWindowSize: 16385,
-        promptTokenCostInMillicents: 0.1,
-        completionTokenCostInMillicents: 0.2,
-    },
-    "gpt-3.5-turbo-0301": {
-        contextWindowSize: 4096,
-        promptTokenCostInMillicents: 0.15,
-        completionTokenCostInMillicents: 0.2,
-    },
-    "gpt-3.5-turbo-0613": {
-        contextWindowSize: 4096,
-        promptTokenCostInMillicents: 0.15,
-        completionTokenCostInMillicents: 0.2,
-        fineTunedPromptTokenCostInMillicents: 1.2,
-        fineTunedCompletionTokenCostInMillicents: 1.6,
-    },
-    "gpt-3.5-turbo-16k": {
-        contextWindowSize: 16384,
-        promptTokenCostInMillicents: 0.3,
-        completionTokenCostInMillicents: 0.4,
-    },
-    "gpt-3.5-turbo-16k-0613": {
-        contextWindowSize: 16384,
-        promptTokenCostInMillicents: 0.3,
-        completionTokenCostInMillicents: 0.4,
-    },
-};
-function getOpenAIChatModelInformation(model) {
-    // Model is already a base model:
-    if (model in exports.OPENAI_CHAT_MODELS) {
-        const baseModelInformation = exports.OPENAI_CHAT_MODELS[model];
-        return {
-            baseModel: model,
-            isFineTuned: false,
-            contextWindowSize: baseModelInformation.contextWindowSize,
-            promptTokenCostInMillicents: baseModelInformation.promptTokenCostInMillicents,
-            completionTokenCostInMillicents: baseModelInformation.completionTokenCostInMillicents,
-        };
-    }
-    // Extract the base model from the fine-tuned model:
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const [_, baseModel, ___, ____, _____] = model.split(":");
-    if (["gpt-3.5-turbo", "gpt-3.5-turbo-0613", "gpt-4-0613"].includes(baseModel)) {
-        const baseModelInformation = exports.OPENAI_CHAT_MODELS[baseModel];
-        return {
-            baseModel: baseModel,
-            isFineTuned: true,
-            contextWindowSize: baseModelInformation.contextWindowSize,
-            promptTokenCostInMillicents: baseModelInformation.fineTunedPromptTokenCostInMillicents,
-            completionTokenCostInMillicents: baseModelInformation.fineTunedCompletionTokenCostInMillicents,
-        };
-    }
-    throw new Error(`Unknown OpenAI chat base model ${baseModel}.`);
-}
-exports.getOpenAIChatModelInformation = getOpenAIChatModelInformation;
-const isOpenAIChatModel = (model) => model in exports.OPENAI_CHAT_MODELS ||
-    model.startsWith("ft:gpt-3.5-turbo-0613:") ||
-    model.startsWith("ft:gpt-3.5-turbo:");
-exports.isOpenAIChatModel = isOpenAIChatModel;
-const calculateOpenAIChatCostInMillicents = ({ model, response, }) => {
-    const { promptTokenCostInMillicents, completionTokenCostInMillicents } = getOpenAIChatModelInformation(model);
-    // null: when cost is unknown, e.g. for fine-tuned models where the price is not yet known
-    if (promptTokenCostInMillicents == null ||
-        completionTokenCostInMillicents == null) {
-        return null;
-    }
-    return (response.usage.prompt_tokens * promptTokenCostInMillicents +
-        response.usage.completion_tokens * completionTokenCostInMillicents);
-};
-exports.calculateOpenAIChatCostInMillicents = calculateOpenAIChatCostInMillicents;
-/**
- * Create a text generation model that calls the OpenAI chat API.
- *
- * @see https://platform.openai.com/docs/api-reference/chat/create
- *
- * @example
- * const model = new OpenAIChatModel({
- *   model: "gpt-3.5-turbo",
- *   temperature: 0.7,
- *   maxGenerationTokens: 500,
- * });
- *
- * const text = await generateText([
- *   model,
- *   openai.ChatMessage.system(
- *     "Write a short story about a robot learning to love:"
- *   ),
- * ]);
- */
-class OpenAIChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpenAIChatModel {
-    constructor(settings) {
-        super(settings);
-        Object.defineProperty(this, "provider", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "openai"
-        });
-        Object.defineProperty(this, "contextWindowSize", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "tokenizer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        const modelInformation = getOpenAIChatModelInformation(this.settings.model);
-        this.tokenizer = new TikTokenTokenizer_js_1.TikTokenTokenizer({
-            model: modelInformation.baseModel,
-        });
-        this.contextWindowSize = modelInformation.contextWindowSize;
-    }
-    get modelName() {
-        return this.settings.model;
-    }
-    /**
-     * Counts the prompt tokens required for the messages. This includes the message base tokens
-     * and the prompt base tokens.
-     */
-    countPromptTokens(messages) {
-        return (0, countOpenAIChatMessageTokens_js_1.countOpenAIChatPromptTokens)({
-            messages,
-            model: this.modelName,
-        });
-    }
-    get settingsForEvent() {
-        const eventSettingProperties = [
-            ...TextGenerationModel_js_1.textGenerationModelProperties,
-            "functions",
-            "functionCall",
-            "temperature",
-            "topP",
-            "presencePenalty",
-            "frequencyPenalty",
-            "logitBias",
-            "seed",
-            "responseFormat",
-        ];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
-    }
-    asFunctionCallObjectGenerationModel({ fnName, fnDescription, }) {
-        return new OpenAIChatFunctionCallObjectGenerationModel_js_1.OpenAIChatFunctionCallObjectGenerationModel({
-            model: this,
-            fnName,
-            fnDescription,
-            promptTemplate: (0, OpenAIChatPromptTemplate_js_1.identity)(),
-        });
-    }
-    asObjectGenerationModel(promptTemplate) {
-        return "adaptModel" in promptTemplate
-            ? new ObjectFromTextStreamingModel_js_1.ObjectFromTextStreamingModel({
-                model: promptTemplate.adaptModel(this),
-                template: promptTemplate,
-            })
-            : new ObjectFromTextStreamingModel_js_1.ObjectFromTextStreamingModel({
-                model: this,
-                template: promptTemplate,
-            });
-    }
-    withTextPrompt() {
-        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.text)());
-    }
-    withInstructionPrompt() {
-        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.instruction)());
-    }
-    withChatPrompt() {
-        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.chat)());
-    }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateFullTextModel_js_1.PromptTemplateFullTextModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
-    withJsonOutput() {
-        return this.withSettings({ responseFormat: { type: "json_object" } });
-    }
-    withSettings(additionalSettings) {
-        return new OpenAIChatModel(Object.assign({}, this.settings, additionalSettings));
-    }
-}
-exports.OpenAIChatModel = OpenAIChatModel;