modelfusion 0.104.0 → 0.106.0

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

@@ -2,10 +2,46 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jsonStructurePrompt = void 0;
 const parseJSON_js_1 = require("../../core/schema/parseJSON.cjs");
-function jsonStructurePrompt(createPrompt) {
-    return {
-        createPrompt,
-        extractStructure: (response) => (0, parseJSON_js_1.parseJSON)({ text: response }),
-    };
+const DEFAULT_SCHEMA_PREFIX = "JSON schema:";
+const DEFAULT_SCHEMA_SUFFIX = "\nYou MUST answer with a JSON object matches the above schema.";
+exports.jsonStructurePrompt = {
+    custom(createPrompt) {
+        return { createPrompt, extractStructure };
+    },
+    text({ schemaPrefix, schemaSuffix, } = {}) {
+        return {
+            createPrompt: (prompt, schema) => ({
+                system: createSystemPrompt({ schema, schemaPrefix, schemaSuffix }),
+                instruction: prompt,
+            }),
+            extractStructure,
+        };
+    },
+    instruction({ schemaPrefix, schemaSuffix, } = {}) {
+        return {
+            createPrompt: (prompt, schema) => ({
+                system: createSystemPrompt({
+                    originalSystemPrompt: prompt.system,
+                    schema,
+                    schemaPrefix,
+                    schemaSuffix,
+                }),
+                instruction: prompt.instruction,
+            }),
+            extractStructure,
+        };
+    },
+};
+function createSystemPrompt({ originalSystemPrompt, schema, schemaPrefix = DEFAULT_SCHEMA_PREFIX, schemaSuffix = DEFAULT_SCHEMA_SUFFIX, }) {
+    return [
+        originalSystemPrompt,
+        schemaPrefix,
+        JSON.stringify(schema.getJsonSchema()),
+        schemaSuffix,
+    ]
+        .filter(Boolean)
+        .join("\n");
+}
+function extractStructure(response) {
+    return (0, parseJSON_js_1.parseJSON)({ text: response });
 }
-exports.jsonStructurePrompt = jsonStructurePrompt;

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

@@ -1,4 +1,15 @@
 import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../core/schema/Schema.js";
+import { InstructionPrompt } from "../../model-function/generate-text/prompt-template/InstructionPrompt.js";
 import { StructureFromTextPromptTemplate } from "./StructureFromTextPromptTemplate.js";
-export declare function jsonStructurePrompt<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
+export declare const jsonStructurePrompt: {
+    custom<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
+    text({ schemaPrefix, schemaSuffix, }?: {
+        schemaPrefix?: string | undefined;
+        schemaSuffix?: string | undefined;
+    }): StructureFromTextPromptTemplate<string, InstructionPrompt>;
+    instruction({ schemaPrefix, schemaSuffix, }?: {
+        schemaPrefix?: string | undefined;
+        schemaSuffix?: string | undefined;
+    }): StructureFromTextPromptTemplate<InstructionPrompt, InstructionPrompt>;
+};

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

@@ -1,7 +1,44 @@
 import { parseJSON } from "../../core/schema/parseJSON.js";
-export function jsonStructurePrompt(createPrompt) {
-    return {
-        createPrompt,
-        extractStructure: (response) => parseJSON({ text: response }),
-    };
+const DEFAULT_SCHEMA_PREFIX = "JSON schema:";
+const DEFAULT_SCHEMA_SUFFIX = "\nYou MUST answer with a JSON object matches the above schema.";
+export const jsonStructurePrompt = {
+    custom(createPrompt) {
+        return { createPrompt, extractStructure };
+    },
+    text({ schemaPrefix, schemaSuffix, } = {}) {
+        return {
+            createPrompt: (prompt, schema) => ({
+                system: createSystemPrompt({ schema, schemaPrefix, schemaSuffix }),
+                instruction: prompt,
+            }),
+            extractStructure,
+        };
+    },
+    instruction({ schemaPrefix, schemaSuffix, } = {}) {
+        return {
+            createPrompt: (prompt, schema) => ({
+                system: createSystemPrompt({
+                    originalSystemPrompt: prompt.system,
+                    schema,
+                    schemaPrefix,
+                    schemaSuffix,
+                }),
+                instruction: prompt.instruction,
+            }),
+            extractStructure,
+        };
+    },
+};
+function createSystemPrompt({ originalSystemPrompt, schema, schemaPrefix = DEFAULT_SCHEMA_PREFIX, schemaSuffix = DEFAULT_SCHEMA_SUFFIX, }) {
+    return [
+        originalSystemPrompt,
+        schemaPrefix,
+        JSON.stringify(schema.getJsonSchema()),
+        schemaSuffix,
+    ]
+        .filter(Boolean)
+        .join("\n");
+}
+function extractStructure(response) {
+    return parseJSON({ text: response });
 }

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

@@ -8,8 +8,8 @@ async function streamStructure(model, schema, prompt, options) {
     const expandedPrompt = typeof prompt === "function"
         ? prompt(schema)
         : prompt;
+    let accumulatedText = "";
     let lastStructure;
-    let lastFullDelta;
     const fullResponse = await (0, executeStreamCall_js_1.executeStreamCall)({
         functionType: "stream-structure",
         input: prompt,
@@ -17,11 +17,14 @@ async function streamStructure(model, schema, prompt, options) {
         options,
         startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
         processDelta: (delta) => {
-            const latestFullDelta = delta.fullDelta;
-            const latestStructure = delta.valueDelta;
+            const textDelta = model.extractStructureTextDelta(delta.deltaValue);
+            if (textDelta == null) {
+                return undefined;
+            }
+            accumulatedText += textDelta;
+            const latestStructure = model.parseAccumulatedStructureText(accumulatedText);
             // only send a new part into the stream when the partial structure has changed:
             if (!(0, isDeepEqualData_js_1.isDeepEqualData)(lastStructure, latestStructure)) {
-                lastFullDelta = latestFullDelta;
                 lastStructure = latestStructure;
                 return {
                     isComplete: false,
@@ -42,10 +45,6 @@ async function streamStructure(model, schema, prompt, options) {
                 value: parseResult.data,
             };
         },
-        getResult: () => ({
-            response: lastFullDelta,
-            value: lastStructure,
-        }),
     });
     return options?.fullResponse
         ? {

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

@@ -27,7 +27,7 @@ export type StructureStreamPart<STRUCTURE> = {
  * @example
  * const structureStream = await streamStructure(
  *   openai.ChatTextGenerator(...).asFunctionCallStructureGenerationModel(...),
- *   new ZodSchema(
+ *   zodSchema(
  *     z.array(
  *       z.object({
  *         name: z.string(),

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

@@ -5,8 +5,8 @@ export async function streamStructure(model, schema, prompt, options) {
     const expandedPrompt = typeof prompt === "function"
         ? prompt(schema)
         : prompt;
+    let accumulatedText = "";
     let lastStructure;
-    let lastFullDelta;
     const fullResponse = await executeStreamCall({
         functionType: "stream-structure",
         input: prompt,
@@ -14,11 +14,14 @@ export async function streamStructure(model, schema, prompt, options) {
         options,
         startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
         processDelta: (delta) => {
-            const latestFullDelta = delta.fullDelta;
-            const latestStructure = delta.valueDelta;
+            const textDelta = model.extractStructureTextDelta(delta.deltaValue);
+            if (textDelta == null) {
+                return undefined;
+            }
+            accumulatedText += textDelta;
+            const latestStructure = model.parseAccumulatedStructureText(accumulatedText);
             // only send a new part into the stream when the partial structure has changed:
             if (!isDeepEqualData(lastStructure, latestStructure)) {
-                lastFullDelta = latestFullDelta;
                 lastStructure = latestStructure;
                 return {
                     isComplete: false,
@@ -39,10 +42,6 @@ export async function streamStructure(model, schema, prompt, options) {
                 value: parseResult.data,
             };
         },
-        getResult: () => ({
-            response: lastFullDelta,
-            value: lastStructure,
-        }),
     });
     return options?.fullResponse
         ? {

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptTemplateFullTextModel = void 0;
+const PromptTemplateTextStreamingModel_js_1 = require("./PromptTemplateTextStreamingModel.cjs");
+class PromptTemplateFullTextModel extends PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel {
+    constructor(options) {
+        super(options);
+    }
+    doGenerateToolCall(tool, prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doGenerateToolCall(tool, mappedPrompt, options);
+    }
+    doGenerateToolCallsOrText(tools, prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doGenerateToolCallsOrText(tools, mappedPrompt, options);
+    }
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateFullTextModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptTemplate.stopSequences,
+                ],
+            }),
+            promptTemplate,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new PromptTemplateFullTextModel({
+            model: this.model.withSettings(additionalSettings),
+            promptTemplate: this.promptTemplate,
+        });
+    }
+}
+exports.PromptTemplateFullTextModel = PromptTemplateFullTextModel;

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

@@ -0,0 +1,41 @@
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { ToolDefinition } from "../../tool/ToolDefinition.js";
+import { ToolCallGenerationModel } from "../../tool/generate-tool-call/ToolCallGenerationModel.js";
+import { ToolCallsOrTextGenerationModel } from "../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
+import { PromptTemplateTextStreamingModel } from "./PromptTemplateTextStreamingModel.js";
+import { TextGenerationModelSettings, TextStreamingModel } from "./TextGenerationModel.js";
+import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
+export declare class PromptTemplateFullTextModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextStreamingModel<MODEL_PROMPT, SETTINGS> & ToolCallGenerationModel<MODEL_PROMPT, SETTINGS> & ToolCallsOrTextGenerationModel<MODEL_PROMPT, SETTINGS>> extends PromptTemplateTextStreamingModel<PROMPT, MODEL_PROMPT, SETTINGS, MODEL> implements TextStreamingModel<PROMPT, SETTINGS>, ToolCallGenerationModel<PROMPT, SETTINGS>, ToolCallsOrTextGenerationModel<PROMPT, SETTINGS> {
+    constructor(options: {
+        model: MODEL;
+        promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
+    });
+    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: PROMPT, options?: FunctionOptions | undefined): PromiseLike<{
+        response: unknown;
+        toolCall: {
+            id: string;
+            args: unknown;
+        } | null;
+        usage?: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        } | undefined;
+    }>;
+    doGenerateToolCallsOrText(tools: ToolDefinition<string, unknown>[], prompt: PROMPT, options?: FunctionOptions | undefined): PromiseLike<{
+        response: unknown;
+        text: string | null;
+        toolCalls: {
+            id: string;
+            name: string;
+            args: unknown;
+        }[] | null;
+        usage?: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        } | undefined;
+    }>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateFullTextModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}

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

@@ -0,0 +1,31 @@
+import { PromptTemplateTextStreamingModel } from "./PromptTemplateTextStreamingModel.js";
+export class PromptTemplateFullTextModel extends PromptTemplateTextStreamingModel {
+    constructor(options) {
+        super(options);
+    }
+    doGenerateToolCall(tool, prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doGenerateToolCall(tool, mappedPrompt, options);
+    }
+    doGenerateToolCallsOrText(tools, prompt, options) {
+        const mappedPrompt = this.promptTemplate.format(prompt);
+        return this.model.doGenerateToolCallsOrText(tools, mappedPrompt, options);
+    }
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateFullTextModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptTemplate.stopSequences,
+                ],
+            }),
+            promptTemplate,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new PromptTemplateFullTextModel({
+            model: this.model.withSettings(additionalSettings),
+            promptTemplate: this.promptTemplate,
+        });
+    }
+}

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

@@ -1,6 +1,7 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { TextGenerationToolCallModel, ToolCallPromptTemplate } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
-import { TextGenerationToolCallsOrGenerateTextModel, ToolCallsOrGenerateTextPromptTemplate } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
+import { TextGenerationToolCallsOrGenerateTextModel } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
+import { ToolCallsOrGenerateTextPromptTemplate } from "../../tool/generate-tool-calls-or-text/ToolCallsOrGenerateTextPromptTemplate.js";
 import { StructureFromTextGenerationModel } from "../generate-structure/StructureFromTextGenerationModel.js";
 import { StructureFromTextPromptTemplate } from "../generate-structure/StructureFromTextPromptTemplate.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerationModel.js";

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

@@ -1,5 +1,5 @@
 import { TextGenerationToolCallModel, } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
-import { TextGenerationToolCallsOrGenerateTextModel, } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
+import { TextGenerationToolCallsOrGenerateTextModel } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
 import { StructureFromTextGenerationModel } from "../generate-structure/StructureFromTextGenerationModel.js";
 export class PromptTemplateTextGenerationModel {
     constructor({ model, promptTemplate, }) {

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

@@ -11,6 +11,9 @@ class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerationModel
         const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doStreamText(mappedPrompt, options);
     }
+    extractTextDelta(delta) {
+        return this.model.extractTextDelta(delta);
+    }
     asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
             model: this,

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

@@ -9,7 +9,8 @@ export declare class PromptTemplateTextStreamingModel<PROMPT, MODEL_PROMPT, SETT
         model: MODEL;
         promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
     });
-    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../Delta.js").Delta<string>>>;
+    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../Delta.js").Delta<unknown>>>;
+    extractTextDelta(delta: unknown): string | undefined;
     asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, PROMPT>): StructureFromTextStreamingModel<INPUT_PROMPT, PROMPT, this>;
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;

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

@@ -8,6 +8,9 @@ export class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerati
         const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doStreamText(mappedPrompt, options);
     }
+    extractTextDelta(delta) {
+        return this.model.extractTextDelta(delta);
+    }
     asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextStreamingModel({
             model: this,

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

@@ -74,6 +74,7 @@ export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationMode
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
 }
 export interface TextStreamingModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends TextGenerationModel<PROMPT, SETTINGS> {
-    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<Delta<string>>>;
+    doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<Delta<unknown>>>;
+    extractTextDelta(delta: unknown): string | undefined;
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
 }

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

@@ -14,6 +14,7 @@ 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);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PromptTemplateFullTextModel.cjs"), exports);
 __exportStar(require("./PromptTemplateTextGenerationModel.cjs"), exports);
 __exportStar(require("./PromptTemplateTextStreamingModel.cjs"), exports);
 __exportStar(require("./TextGenerationEvent.cjs"), exports);

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

@@ -1,3 +1,4 @@
+export * from "./PromptTemplateFullTextModel.js";
 export * from "./PromptTemplateTextGenerationModel.js";
 export * from "./PromptTemplateTextStreamingModel.js";
 export * from "./TextGenerationEvent.js";

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

@@ -1,3 +1,4 @@
+export * from "./PromptTemplateFullTextModel.js";
 export * from "./PromptTemplateTextGenerationModel.js";
 export * from "./PromptTemplateTextStreamingModel.js";
 export * from "./TextGenerationEvent.js";

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.instruction = exports.text = void 0;
-const Content_js_1 = require("./Content.cjs");
+const ContentPart_js_1 = require("./ContentPart.cjs");
 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.";
 /**
@@ -68,7 +68,7 @@ function instruction() {
             if (prompt.system != null) {
                 text += `${prompt.system}\n`;
             }
-            text += (0, Content_js_1.validateContentIsString)(prompt.instruction, prompt);
+            text += (0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt);
             if (prompt.input != null) {
                 text += `\n\n### Input:\n${prompt.input}`;
             }

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

@@ -1,4 +1,4 @@
-import { validateContentIsString } from "./Content.js";
+import { validateContentIsString } from "./ContentPart.js";
 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.";
 /**

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

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = void 0;
-const Content_js_1 = require("./Content.cjs");
+const ContentPart_js_1 = require("./ContentPart.cjs");
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
 const START_SEGMENT = "<|im_start|>";
 const END_SEGMENT = "<|im_end|>";
 function segmentStart(role) {
@@ -40,7 +41,7 @@ function instruction() {
     return {
         stopSequences: [END_SEGMENT],
         format(prompt) {
-            const instruction = (0, Content_js_1.validateContentIsString)(prompt.instruction, prompt);
+            const instruction = (0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt);
             return (segment("system", prompt.system) +
                 segment("user", instruction) +
                 segmentStart("assistant") +
@@ -69,14 +70,16 @@ function chat() {
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        const textContent = (0, Content_js_1.validateContentIsString)(content, prompt);
-                        text += segment("user", textContent);
+                        text += segment("user", (0, ContentPart_js_1.validateContentIsString)(content, prompt));
                         break;
                     }
                     case "assistant": {
-                        text += segment("assistant", content);
+                        text += segment("assistant", (0, ContentPart_js_1.validateContentIsString)(content, prompt));
                         break;
                     }
+                    case "tool": {
+                        throw new InvalidPromptError_js_1.InvalidPromptError("Tool messages are not supported.", prompt);
+                    }
                     default: {
                         const _exhaustiveCheck = role;
                         throw new Error(`Unsupported role: ${_exhaustiveCheck}`);

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

@@ -1,4 +1,5 @@
-import { validateContentIsString } from "./Content.js";
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
 const START_SEGMENT = "<|im_start|>";
 const END_SEGMENT = "<|im_end|>";
 function segmentStart(role) {
@@ -64,14 +65,16 @@ export function chat() {
             for (const { role, content } of prompt.messages) {
                 switch (role) {
                     case "user": {
-                        const textContent = validateContentIsString(content, prompt);
-                        text += segment("user", textContent);
+                        text += segment("user", validateContentIsString(content, prompt));
                         break;
                     }
                     case "assistant": {
-                        text += segment("assistant", content);
+                        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}`);

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

@@ -1,2 +1,44 @@
 "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,10 +1,14 @@
-import { Content } from "./Content.js";
+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 and assistant messages.
+ * 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.
+ * Note: Not all models and prompt formats support multi-modal inputs and tool calls.
+ * The validation happens at runtime.
  *
  * @example
  * ```ts
@@ -22,6 +26,9 @@ 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.
  *
@@ -29,8 +36,23 @@ export interface ChatPrompt {
  */
 export type ChatMessage = {
     role: "user";
-    content: Content;
+    content: UserContent;
 } | {
     role: "assistant";
-    content: string;
+    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 +1,41 @@
-export {};
+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/{Content.cjs → ContentPart.cjs}

@@ -4,7 +4,7 @@ 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);
+        throw new InvalidPromptError_js_1.InvalidPromptError("Only text prompts are are supported by this prompt template.", prompt);
     }
     return content;
 }