modelfusion 0.132.0 → 0.134.0

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.d.ts

@@ -1,35 +0,0 @@
-import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
-import { ChatPrompt } from "./ChatPrompt.js";
-import { InstructionPrompt } from "./InstructionPrompt.js";
-/**
- * Formats a text prompt using the ChatML format.
- */
-export declare function text(): TextGenerationPromptTemplate<string, string>;
-/**
- * Formats an instruction prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * ${ system prompt }<|im_end|>
- * <|im_start|>user
- * ${ instruction }<|im_end|>
- * <|im_start|>assistant
- * ${response prefix}
- * ```
- */
-export declare function instruction(): TextGenerationPromptTemplate<InstructionPrompt, string>;
-/**
- * Formats a chat prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
- * <|im_start|>user
- * What is the capital of France?<|im_end|>
- * <|im_start|>assistant
- * Paris<|im_end|>
- * ```
- */
-export declare function chat(): TextGenerationPromptTemplate<ChatPrompt, string>;

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.js

@@ -1,90 +0,0 @@
-import { validateContentIsString } from "./ContentPart.js";
-import { InvalidPromptError } from "./InvalidPromptError.js";
-const START_SEGMENT = "<|im_start|>";
-const END_SEGMENT = "<|im_end|>";
-function segmentStart(role) {
-    return `${START_SEGMENT}${role}\n`;
-}
-function segment(role, text) {
-    return text == null ? "" : `${segmentStart(role)}${text}${END_SEGMENT}\n`;
-}
-/**
- * Formats a text prompt using the ChatML format.
- */
-export function text() {
-    return {
-        stopSequences: [END_SEGMENT],
-        format(prompt) {
-            // prompt and then prefix start of assistant response:
-            return segment("user", prompt) + segmentStart("assistant");
-        },
-    };
-}
-/**
- * Formats an instruction prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * ${ system prompt }<|im_end|>
- * <|im_start|>user
- * ${ instruction }<|im_end|>
- * <|im_start|>assistant
- * ${response prefix}
- * ```
- */
-export function instruction() {
-    return {
-        stopSequences: [END_SEGMENT],
-        format(prompt) {
-            const instruction = validateContentIsString(prompt.instruction, prompt);
-            return (segment("system", prompt.system) +
-                segment("user", instruction) +
-                segmentStart("assistant") +
-                (prompt.responsePrefix ?? ""));
-        },
-    };
-}
-/**
- * Formats a chat prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
- * <|im_start|>user
- * What is the capital of France?<|im_end|>
- * <|im_start|>assistant
- * Paris<|im_end|>
- * ```
- */
-export function chat() {
-    return {
-        format(prompt) {
-            let text = prompt.system != null ? segment("system", prompt.system) : "";
-            for (const { role, content } of prompt.messages) {
-                switch (role) {
-                    case "user": {
-                        text += segment("user", validateContentIsString(content, prompt));
-                        break;
-                    }
-                    case "assistant": {
-                        text += segment("assistant", validateContentIsString(content, prompt));
-                        break;
-                    }
-                    case "tool": {
-                        throw new InvalidPromptError("Tool messages are not supported.", prompt);
-                    }
-                    default: {
-                        const _exhaustiveCheck = role;
-                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
-                    }
-                }
-            }
-            // prefix start of assistant response:
-            text += segmentStart("assistant");
-            return text;
-        },
-        stopSequences: [END_SEGMENT],
-    };
-}

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.test.cjs

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ChatMLPromptTemplate_js_1 = require("./ChatMLPromptTemplate.cjs");
-describe("text prompt", () => {
-    it("should format prompt", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.text)().format("prompt");
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("instruction prompt", () => {
-    it("should format prompt with instruction", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system and instruction", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
-            system: "system",
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with instruction and response prefix", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.instruction)().format({
-            instruction: "instruction",
-            responsePrefix: "response prefix",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("chat prompt", () => {
-    it("should format prompt with user message", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.chat)().format({
-            messages: [{ role: "user", content: "user message" }],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with user-assistant-user messages", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.chat)().format({
-            messages: [
-                { role: "user", content: "1st user message" },
-                { role: "assistant", content: "assistant message" },
-                { role: "user", content: "2nd user message" },
-            ],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system message and user-assistant-user messages", () => {
-        const prompt = (0, ChatMLPromptTemplate_js_1.chat)().format({
-            system: "you are a chatbot",
-            messages: [
-                { role: "user", content: "1st user message" },
-                { role: "assistant", content: "assistant message" },
-                { role: "user", content: "2nd user message" },
-            ],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.test.d.ts

@@ -1 +0,0 @@
-export {};

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.test.js

@@ -1,58 +0,0 @@
-import { chat, instruction, text } from "./ChatMLPromptTemplate.js";
-describe("text prompt", () => {
-    it("should format prompt", () => {
-        const prompt = text().format("prompt");
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("instruction prompt", () => {
-    it("should format prompt with instruction", () => {
-        const prompt = instruction().format({
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system and instruction", () => {
-        const prompt = instruction().format({
-            system: "system",
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with instruction and response prefix", () => {
-        const prompt = instruction().format({
-            instruction: "instruction",
-            responsePrefix: "response prefix",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("chat prompt", () => {
-    it("should format prompt with user message", () => {
-        const prompt = chat().format({
-            messages: [{ role: "user", content: "user message" }],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with user-assistant-user messages", () => {
-        const prompt = chat().format({
-            messages: [
-                { role: "user", content: "1st user message" },
-                { role: "assistant", content: "assistant message" },
-                { role: "user", content: "2nd user message" },
-            ],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system message and user-assistant-user messages", () => {
-        const prompt = chat().format({
-            system: "you are a chatbot",
-            messages: [
-                { role: "user", content: "1st user message" },
-                { role: "assistant", content: "assistant message" },
-                { role: "user", content: "2nd user message" },
-            ],
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});

package/model-function/generate-text/prompt-template/ChatPrompt.cjs

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatMessage = void 0;
-exports.ChatMessage = {
-    user({ text }) {
-        return {
-            role: "user",
-            content: text,
-        };
-    },
-    tool({ toolResults, }) {
-        return {
-            role: "tool",
-            content: createToolContent({ toolResults }),
-        };
-    },
-    assistant({ text, toolResults, }) {
-        return {
-            role: "assistant",
-            content: createAssistantContent({ text, toolResults }),
-        };
-    },
-};
-function createToolContent({ toolResults, }) {
-    const toolContent = [];
-    for (const { result, toolCall } of toolResults ?? []) {
-        toolContent.push({
-            type: "tool-response",
-            id: toolCall.id,
-            response: result,
-        });
-    }
-    return toolContent;
-}
-function createAssistantContent({ text, toolResults, }) {
-    const content = [];
-    if (text != null) {
-        content.push({ type: "text", text });
-    }
-    for (const { toolCall } of toolResults ?? []) {
-        content.push({ type: "tool-call", ...toolCall });
-    }
-    return content;
-}

package/model-function/generate-text/prompt-template/ChatPrompt.d.ts

@@ -1,58 +0,0 @@
-import { ToolCallResult } from "../../../tool/ToolCallResult.js";
-import { ImagePart, TextPart, ToolCallPart, ToolResponsePart } from "./ContentPart.js";
-/**
- * A chat prompt is a combination of a system message and a list
- * of user, assistant, and tool messages.
- *
- * The user messages can contain multi-modal content.
- * The assistant messages can contain tool calls.
- *
- * Note: Not all models and prompt formats support multi-modal inputs and tool calls.
- * The validation happens at runtime.
- *
- * @example
- * ```ts
- * const chatPrompt: ChatPrompt = {
- *   system: "You are a celebrated poet.",
- *   messages: [
- *    { role: "user", content: "Write a short story about a robot learning to love." },
- *    { role: "assistant", content: "Once upon a time, there was a robot who learned to love." },
- *    { role: "user", content: "That's a great start!" },
- *  ],
- * };
- * ```
- */
-export interface ChatPrompt {
-    system?: string;
-    messages: Array<ChatMessage>;
-}
-export type UserContent = string | Array<TextPart | ImagePart>;
-export type AssistantContent = string | Array<TextPart | ToolCallPart>;
-export type ToolContent = Array<ToolResponsePart>;
-/**
- * A message in a chat prompt.
- *
- * @see ChatPrompt
- */
-export type ChatMessage = {
-    role: "user";
-    content: UserContent;
-} | {
-    role: "assistant";
-    content: AssistantContent;
-} | {
-    role: "tool";
-    content: ToolContent;
-};
-export declare const ChatMessage: {
-    user({ text }: {
-        text: string;
-    }): ChatMessage;
-    tool({ toolResults, }: {
-        toolResults: ToolCallResult<string, unknown, unknown>[] | null;
-    }): ChatMessage;
-    assistant({ text, toolResults, }: {
-        text: string | null;
-        toolResults: ToolCallResult<string, unknown, unknown>[] | null;
-    }): ChatMessage;
-};

package/model-function/generate-text/prompt-template/ChatPrompt.js

@@ -1,41 +0,0 @@
-export const ChatMessage = {
-    user({ text }) {
-        return {
-            role: "user",
-            content: text,
-        };
-    },
-    tool({ toolResults, }) {
-        return {
-            role: "tool",
-            content: createToolContent({ toolResults }),
-        };
-    },
-    assistant({ text, toolResults, }) {
-        return {
-            role: "assistant",
-            content: createAssistantContent({ text, toolResults }),
-        };
-    },
-};
-function createToolContent({ toolResults, }) {
-    const toolContent = [];
-    for (const { result, toolCall } of toolResults ?? []) {
-        toolContent.push({
-            type: "tool-response",
-            id: toolCall.id,
-            response: result,
-        });
-    }
-    return toolContent;
-}
-function createAssistantContent({ text, toolResults, }) {
-    const content = [];
-    if (text != null) {
-        content.push({ type: "text", text });
-    }
-    for (const { toolCall } of toolResults ?? []) {
-        content.push({ type: "tool-call", ...toolCall });
-    }
-    return content;
-}

package/model-function/generate-text/prompt-template/ContentPart.cjs

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateContentIsString = void 0;
-const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
-function validateContentIsString(content, prompt) {
-    if (typeof content !== "string") {
-        throw new InvalidPromptError_js_1.InvalidPromptError("Only text prompts are are supported by this prompt template.", prompt);
-    }
-    return content;
-}
-exports.validateContentIsString = validateContentIsString;

package/model-function/generate-text/prompt-template/ContentPart.d.ts

@@ -1,31 +0,0 @@
-import { DataContent } from "../../../util/format/DataContent.js";
-export interface TextPart {
-    type: "text";
-    /**
-     * The text content.
-     */
-    text: string;
-}
-export interface ImagePart {
-    type: "image";
-    /**
-     * Image data. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
-     */
-    image: DataContent;
-    /**
-     * Optional mime type of the image.
-     */
-    mimeType?: string;
-}
-export interface ToolCallPart {
-    type: "tool-call";
-    id: string;
-    name: string;
-    args: unknown;
-}
-export interface ToolResponsePart {
-    type: "tool-response";
-    id: string;
-    response: unknown;
-}
-export declare function validateContentIsString(content: string | unknown, prompt: unknown): string;

package/model-function/generate-text/prompt-template/ContentPart.js

@@ -1,7 +0,0 @@
-import { InvalidPromptError } from "./InvalidPromptError.js";
-export function validateContentIsString(content, prompt) {
-    if (typeof content !== "string") {
-        throw new InvalidPromptError("Only text prompts are are supported by this prompt template.", prompt);
-    }
-    return content;
-}

package/model-function/generate-text/prompt-template/InstructionPrompt.cjs

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/model-function/generate-text/prompt-template/InstructionPrompt.d.ts

@@ -1,32 +0,0 @@
-import { ImagePart, TextPart } from "./ContentPart";
-/**
- * A single text instruction prompt. It can contain an optional system message to define
- * the role and behavior of the language model.
- *
- * The instruction can be a text instruction or a multi-modal instruction.
- *
- * @example
- * ```ts
- * {
- *   system: "You are a celebrated poet.", // optional
- *   instruction: "Write a story about a robot learning to love",
- * }
- * ```
- */
-export interface InstructionPrompt {
-    /**
-     * Optional system message to provide context for the language model. Note that for some models,
-     * changing the system message can impact the results, because the model may be trained on the default system message.
-     */
-    system?: string;
-    /**
-     * The instruction for the model.
-     */
-    instruction: InstructionContent;
-    /**
-     * Response prefix that will be injected in the prompt at the beginning of the response.
-     * This is useful for guiding the model by starting its response with a specific text.
-     */
-    responsePrefix?: string;
-}
-export type InstructionContent = string | Array<TextPart | ImagePart>;

package/model-function/generate-text/prompt-template/InstructionPrompt.js

@@ -1 +0,0 @@
-export {};

package/model-function/generate-text/prompt-template/InvalidPromptError.cjs

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidPromptError = void 0;
-/**
- * Error thrown when a prompt validation fails.
- */
-class InvalidPromptError extends Error {
-    constructor(message, prompt) {
-        super(message);
-        Object.defineProperty(this, "prompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "InvalidPromptError";
-        this.prompt = prompt;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            message: this.message,
-            stack: this.stack,
-            prompt: this.prompt,
-        };
-    }
-}
-exports.InvalidPromptError = InvalidPromptError;

package/model-function/generate-text/prompt-template/InvalidPromptError.d.ts

@@ -1,13 +0,0 @@
-/**
- * Error thrown when a prompt validation fails.
- */
-export declare class InvalidPromptError extends Error {
-    readonly prompt: unknown;
-    constructor(message: string, prompt: unknown);
-    toJSON(): {
-        name: string;
-        message: string;
-        stack: string | undefined;
-        prompt: unknown;
-    };
-}

package/model-function/generate-text/prompt-template/InvalidPromptError.js

@@ -1,24 +0,0 @@
-/**
- * Error thrown when a prompt validation fails.
- */
-export class InvalidPromptError extends Error {
-    constructor(message, prompt) {
-        super(message);
-        Object.defineProperty(this, "prompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "InvalidPromptError";
-        this.prompt = prompt;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            message: this.message,
-            stack: this.stack,
-            prompt: this.prompt,
-        };
-    }
-}