modelfusion 0.68.1 → 0.70.0

package/README.md

@@ -26,7 +26,7 @@
 ## Quick Install
 
 > [!NOTE]
-> ModelFusion is in its initial development phase. The main API is now mostly stable, but until version 1.0 there may be minor breaking changes. Feedback and suggestions are welcome.
+> ModelFusion is in its initial development phase. The main API is now mostly stable, but until version 1.0 there may be breaking changes. Feedback and suggestions are welcome.
 
 ```sh
 npm install modelfusion
@@ -470,13 +470,14 @@ Prompt formats let you use higher level prompt structures (such as instruction o
 #### [Text Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-text#prompt-format)
 
 ```ts
+// example assumes you are running https://huggingface.co/TheBloke/Llama-2-7B-GGUF with llama.cpp
 const text = await generateText(
   new LlamaCppTextGenerationModel({
     contextWindowSize: 4096, // Llama 2 context window size
     maxCompletionTokens: 1000,
   })
-    .withTextPrompt()
-    .withPromptFormat(mapInstructionPromptToLlama2Format()),
+    .withTextPrompt() // pure text prompt (no images)
+    .withPromptFormat(Llama2PromptFormat.instruction()),
   {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
@@ -491,12 +492,23 @@ const textStream = await streamText(
   new OpenAIChatModel({
     model: "gpt-3.5-turbo",
   }).withChatPrompt(),
-  [
-    { system: "You are a celebrated poet." },
-    { user: "Write a short story about a robot learning to love." },
-    { ai: "Once upon a time, there was a robot who learned to love." },
-    { user: "That's a great start!" },
-  ]
+  {
+    system: "You are a celebrated poet.",
+    messages: [
+      {
+        role: "user",
+        content: "Suggest a name for a robot.",
+      },
+      {
+        role: "assistant",
+        content: "I suggest the name Robbie",
+      },
+      {
+        role: "user",
+        content: "Write a short story about Robbie learning to love",
+      },
+    ],
+  }
 );
 ```
 
@@ -505,6 +517,7 @@ const textStream = await streamText(
 | OpenAI Chat   | ✅                 | ✅          |
 | Anthropic     | ✅                 | ✅          |
 | Llama 2       | ✅                 | ✅          |
+| ChatML        | ✅                 | ✅          |
 | Alpaca        | ✅                 | ❌          |
 | Vicuna        | ❌                 | ✅          |
 | Generic Text  | ✅                 | ✅          |

package/core/schema/JSONParseError.cjs

@@ -34,8 +34,8 @@ class JSONParseError extends Error {
             name: this.name,
             message: this.message,
             cause: this.cause,
-            valueText: this.text,
             stack: this.stack,
+            valueText: this.text,
         };
     }
 }

package/core/schema/JSONParseError.d.ts

@@ -10,7 +10,7 @@ export declare class JSONParseError extends Error {
         name: string;
         message: string;
         cause: unknown;
-        valueText: string;
         stack: string | undefined;
+        valueText: string;
     };
 }

package/core/schema/JSONParseError.js

@@ -31,8 +31,8 @@ export class JSONParseError extends Error {
             name: this.name,
             message: this.message,
             cause: this.cause,
-            valueText: this.text,
             stack: this.stack,
+            valueText: this.text,
         };
     }
 }

package/model-function/ModelCallEvent.d.ts

@@ -6,6 +6,7 @@ import { SpeechGenerationFinishedEvent, SpeechGenerationStartedEvent, SpeechStre
 import { StructureGenerationFinishedEvent, StructureGenerationStartedEvent } from "./generate-structure/StructureGenerationEvent.js";
 import { StructureStreamingFinishedEvent, StructureStreamingStartedEvent } from "./generate-structure/StructureStreamingEvent.js";
 import { TextGenerationFinishedEvent, TextGenerationStartedEvent, TextStreamingFinishedEvent, TextStreamingStartedEvent } from "./generate-text/TextGenerationEvent.js";
+import { ToolCallGenerationFinishedEvent, ToolCallGenerationStartedEvent } from "./generate-tool-call/ToolCallGenerationEvent.js";
 import { TranscriptionFinishedEvent, TranscriptionStartedEvent } from "./generate-transcription/TranscriptionEvent.js";
 export interface BaseModelCallStartedEvent extends BaseFunctionStartedEvent {
     model: ModelInformation;
@@ -47,5 +48,5 @@ export interface BaseModelCallFinishedEvent extends BaseFunctionFinishedEvent {
      */
     result: BaseModelCallFinishedEventResult;
 }
-export type ModelCallStartedEvent = EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | TranscriptionStartedEvent;
-export type ModelCallFinishedEvent = EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | TranscriptionFinishedEvent;
+export type ModelCallStartedEvent = EmbeddingStartedEvent | ImageGenerationStartedEvent | SpeechGenerationStartedEvent | SpeechStreamingStartedEvent | StructureGenerationStartedEvent | StructureStreamingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | ToolCallGenerationStartedEvent | TranscriptionStartedEvent;
+export type ModelCallFinishedEvent = EmbeddingFinishedEvent | ImageGenerationFinishedEvent | SpeechGenerationFinishedEvent | SpeechStreamingFinishedEvent | StructureGenerationFinishedEvent | StructureStreamingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | ToolCallGenerationFinishedEvent | TranscriptionFinishedEvent;

package/model-function/generate-structure/StructureValidationError.cjs

@@ -37,5 +37,16 @@ class StructureValidationError extends Error {
         this.value = value;
         this.valueText = valueText;
     }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            cause: this.cause,
+            stack: this.stack,
+            structureName: this.structureName,
+            value: this.value,
+            valueText: this.valueText,
+        };
+    }
 }
 exports.StructureValidationError = StructureValidationError;

package/model-function/generate-structure/StructureValidationError.d.ts

@@ -9,4 +9,13 @@ export declare class StructureValidationError extends Error {
         valueText: string;
         cause: unknown;
     });
+    toJSON(): {
+        name: string;
+        message: string;
+        cause: unknown;
+        stack: string | undefined;
+        structureName: string;
+        value: unknown;
+        valueText: string;
+    };
 }

package/model-function/generate-structure/StructureValidationError.js

@@ -34,4 +34,15 @@ export class StructureValidationError extends Error {
         this.value = value;
         this.valueText = valueText;
     }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            cause: this.cause,
+            stack: this.stack,
+            structureName: this.structureName,
+            value: this.value,
+            valueText: this.valueText,
+        };
+    }
 }

package/model-function/generate-text/index.cjs

@@ -20,12 +20,5 @@ __exportStar(require("./TextGenerationEvent.cjs"), exports);
 __exportStar(require("./TextGenerationModel.cjs"), exports);
 __exportStar(require("./TextGenerationPromptFormat.cjs"), exports);
 __exportStar(require("./generateText.cjs"), exports);
-__exportStar(require("./prompt-format/AlpacaPromptFormat.cjs"), exports);
-__exportStar(require("./prompt-format/ChatPrompt.cjs"), exports);
-__exportStar(require("./prompt-format/InstructionPrompt.cjs"), exports);
-__exportStar(require("./prompt-format/Llama2PromptFormat.cjs"), exports);
-__exportStar(require("./prompt-format/TextPromptFormat.cjs"), exports);
-__exportStar(require("./prompt-format/VicunaPromptFormat.cjs"), exports);
-__exportStar(require("./prompt-format/trimChatPrompt.cjs"), exports);
-__exportStar(require("./prompt-format/validateChatPrompt.cjs"), exports);
+__exportStar(require("./prompt-format/index.cjs"), exports);
 __exportStar(require("./streamText.cjs"), exports);

package/model-function/generate-text/index.d.ts

@@ -4,12 +4,5 @@ export * from "./TextGenerationEvent.js";
 export * from "./TextGenerationModel.js";
 export * from "./TextGenerationPromptFormat.js";
 export * from "./generateText.js";
-export * from "./prompt-format/AlpacaPromptFormat.js";
-export * from "./prompt-format/ChatPrompt.js";
-export * from "./prompt-format/InstructionPrompt.js";
-export * from "./prompt-format/Llama2PromptFormat.js";
-export * from "./prompt-format/TextPromptFormat.js";
-export * from "./prompt-format/VicunaPromptFormat.js";
-export * from "./prompt-format/trimChatPrompt.js";
-export * from "./prompt-format/validateChatPrompt.js";
+export * from "./prompt-format/index.js";
 export * from "./streamText.js";

package/model-function/generate-text/index.js

@@ -4,12 +4,5 @@ export * from "./TextGenerationEvent.js";
 export * from "./TextGenerationModel.js";
 export * from "./TextGenerationPromptFormat.js";
 export * from "./generateText.js";
-export * from "./prompt-format/AlpacaPromptFormat.js";
-export * from "./prompt-format/ChatPrompt.js";
-export * from "./prompt-format/InstructionPrompt.js";
-export * from "./prompt-format/Llama2PromptFormat.js";
-export * from "./prompt-format/TextPromptFormat.js";
-export * from "./prompt-format/VicunaPromptFormat.js";
-export * from "./prompt-format/trimChatPrompt.js";
-export * from "./prompt-format/validateChatPrompt.js";
+export * from "./prompt-format/index.js";
 export * from "./streamText.js";

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapInstructionPromptToAlpacaFormat = void 0;
+exports.instruction = void 0;
 const DEFAULT_SYSTEM_PROMPT_INPUT = "Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.";
 const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a task. Write a response that appropriately completes the request.";
 /**
@@ -9,9 +9,37 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
+ * Prompt format with input:
+ * ```
+ * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Input:
+ *
+ * {input}
+ *
+ * ### Response:
+ *
+ * ```
+ *
+ * Prompt format without input:
+ * ```
+ * Below is an instruction that describes a task. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Response:
+ *
+ * ```
+ *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-function mapInstructionPromptToAlpacaFormat() {
+function instruction() {
     return {
         stopSequences: [],
         format: (instruction) => {
@@ -32,4 +60,4 @@ function mapInstructionPromptToAlpacaFormat() {
         },
     };
 }
-exports.mapInstructionPromptToAlpacaFormat = mapInstructionPromptToAlpacaFormat;
+exports.instruction = instruction;

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.d.ts

@@ -6,6 +6,34 @@ import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
+ * Prompt format with input:
+ * ```
+ * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Input:
+ *
+ * {input}
+ *
+ * ### Response:
+ *
+ * ```
+ *
+ * Prompt format without input:
+ * ```
+ * Below is an instruction that describes a task. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Response:
+ *
+ * ```
+ *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare function mapInstructionPromptToAlpacaFormat(): TextGenerationPromptFormat<InstructionPrompt, string>;
+export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt, string>;

package/model-function/generate-text/prompt-format/AlpacaPromptFormat.js

@@ -6,9 +6,37 @@ const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
+ * Prompt format with input:
+ * ```
+ * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Input:
+ *
+ * {input}
+ *
+ * ### Response:
+ *
+ * ```
+ *
+ * Prompt format without input:
+ * ```
+ * Below is an instruction that describes a task. Write a response that appropriately completes the request.
+ *
+ * ### Instruction:
+ *
+ * {instruction}
+ *
+ * ### Response:
+ *
+ * ```
+ *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export function mapInstructionPromptToAlpacaFormat() {
+export function instruction() {
     return {
         stopSequences: [],
         format: (instruction) => {

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.cjs

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chat = exports.instruction = void 0;
+const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
+const START_SEGMENT = "<|im_start|>";
+const END_SEGMENT = "<|im_end|>";
+function chatMLStart(role) {
+    return `${START_SEGMENT}${role}\n`;
+}
+function chatMLSegment(role, text) {
+    return text == null ? "" : `${chatMLStart(role)}${text}${END_SEGMENT}\n`;
+}
+/**
+ * Formats an instruction 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|>
+ * ```
+ */
+function instruction() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => chatMLSegment("system", instruction.system) +
+            chatMLSegment("user", instruction.instruction + instruction.input != null
+                ? `\n\n${instruction.input}`
+                : ""),
+    };
+}
+exports.instruction = instruction;
+/**
+ * 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|>
+ * ```
+ */
+function chat() {
+    return {
+        format: (chatPrompt) => {
+            (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
+            let text = chatPrompt.system != null
+                ? chatMLSegment("system", chatPrompt.system)
+                : "";
+            for (const { role, content } of chatPrompt.messages) {
+                switch (role) {
+                    case "user": {
+                        text += chatMLSegment("user", content);
+                        break;
+                    }
+                    case "assistant": {
+                        text += chatMLSegment("assistant", content);
+                        break;
+                    }
+                    default: {
+                        const _exhaustiveCheck = role;
+                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                    }
+                }
+            }
+            // prefix start of assistant response:
+            text += chatMLStart("assistant");
+            return text;
+        },
+        stopSequences: [END_SEGMENT],
+    };
+}
+exports.chat = chat;

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.d.ts

@@ -0,0 +1,31 @@
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+/**
+ * Formats an instruction 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 instruction(): TextGenerationPromptFormat<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(): TextGenerationPromptFormat<ChatPrompt, string>;

package/model-function/generate-text/prompt-format/ChatMLPromptFormat.js

@@ -0,0 +1,74 @@
+import { validateChatPrompt } from "./validateChatPrompt.js";
+const START_SEGMENT = "<|im_start|>";
+const END_SEGMENT = "<|im_end|>";
+function chatMLStart(role) {
+    return `${START_SEGMENT}${role}\n`;
+}
+function chatMLSegment(role, text) {
+    return text == null ? "" : `${chatMLStart(role)}${text}${END_SEGMENT}\n`;
+}
+/**
+ * Formats an instruction 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 instruction() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => chatMLSegment("system", instruction.system) +
+            chatMLSegment("user", instruction.instruction + instruction.input != null
+                ? `\n\n${instruction.input}`
+                : ""),
+    };
+}
+/**
+ * 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: (chatPrompt) => {
+            validateChatPrompt(chatPrompt);
+            let text = chatPrompt.system != null
+                ? chatMLSegment("system", chatPrompt.system)
+                : "";
+            for (const { role, content } of chatPrompt.messages) {
+                switch (role) {
+                    case "user": {
+                        text += chatMLSegment("user", content);
+                        break;
+                    }
+                    case "assistant": {
+                        text += chatMLSegment("assistant", content);
+                        break;
+                    }
+                    default: {
+                        const _exhaustiveCheck = role;
+                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                    }
+                }
+            }
+            // prefix start of assistant response:
+            text += chatMLStart("assistant");
+            return text;
+        },
+        stopSequences: [END_SEGMENT],
+    };
+}

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

@@ -1,33 +1,38 @@
 /**
- * A chat prompt is a sequence of messages with the following structure:
+ * A chat prompt is a combination of a system message and a list of messages with the following constraints:
  *
- * - A chat prompt can optionally start with a system message.
- * - After the optional system message, the first message of the chat must be a user message.
- * - Then it must be alternating between an ai message and a user message.
- * - The last message must always be a user message.
+ * - A chat prompt can optionally have a system message.
+ * - The first message of the chat must be a user message.
+ * - Then it must be alternating between an assistant message and a user message.
+ * - The last message must always be a user message (when submitting to a model).
  *
- * The type checking is done at runtime, because there a no good ways to do it statically.
+ * You can use a ChatPrompt without an final user message when you e.g. want to display the current state of a conversation.
+ *
+ * The type checking is done at runtime when you submit a chat prompt to a model with a prompt format.
  *
  * @example
  * ```ts
- * [
- *   { system: "You are a celebrated poet." },
- *   { user: "Write a short story about a robot learning to love." },
- *   { ai: "Once upon a time, there was a robot who learned to love." },
- *   { user: "That's a great start!" },
- *  ]
+ * 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!" },
+ *  ],
+ * };
  * ```
  *
  * @see validateChatPrompt
  */
-export type ChatPrompt = [...({
-    user: string;
-} | {
-    ai: string;
-})[]] | [{
-    system: string;
-}, ...({
-    user: string;
-} | {
-    ai: string;
-})[]];
+export type ChatPrompt = {
+    system?: string;
+    messages: Array<ChatMessage>;
+};
+/**
+ * A message in a chat prompt.
+ * @see ChatPrompt
+ */
+export type ChatMessage = {
+    role: "user" | "assistant";
+    content: string;
+};

package/model-function/generate-text/prompt-format/ChatPromptValidationError.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatPromptValidationError = void 0;
+class ChatPromptValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ChatPromptValidationError";
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            stack: this.stack,
+        };
+    }
+}
+exports.ChatPromptValidationError = ChatPromptValidationError;

package/model-function/generate-text/prompt-format/ChatPromptValidationError.d.ts

@@ -0,0 +1,8 @@
+export declare class ChatPromptValidationError extends Error {
+    constructor(message: string);
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string | undefined;
+    };
+}

package/model-function/generate-text/prompt-format/ChatPromptValidationError.js

@@ -0,0 +1,13 @@
+export class ChatPromptValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ChatPromptValidationError";
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            stack: this.stack,
+        };
+    }
+}