modelfusion 0.120.0 → 0.121.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.121.0 - 2024-01-09
+
+### Added
+
+- Synthia prompt template
+
+### Changed
+
+- **breaking change**: Renamed `parentCallId` function parameter to `callId` to enable options pass-through.
+- Better output filtering for `detailed-object` log format (e.g. via `modelfusion.setLogFormat("detailed-object")`)
+
 ## v0.120.0 - 2024-01-09
 
 ### Added

package/README.md

@@ -473,13 +473,13 @@ const textStream = await streamText(
 
 | Prompt Template  | Text Prompt | Instruction Prompt | Chat Prompt |
 | ---------------- | ----------- | ------------------ | ----------- |
-| OpenAI Chat      | ✅          | ✅                 | ✅          |
-| Llama 2          | ✅          | ✅                 | ✅          |
+| Alpaca           | ✅          | ✅                 | ❌          |
 | ChatML           | ✅          | ✅                 | ✅          |
-| NeuralChat       | ✅          | ✅                 | ✅          |
+| Llama 2          | ✅          | ✅                 | ✅          |
 | Mistral Instruct | ✅          | ✅                 | ✅          |
-| Alpaca           | ✅          | ✅                 | ❌          |
-| Vicuna           | ❌          | ❌                 | ✅          |
+| NeuralChat       | ✅          | ✅                 | ✅          |
+| Synthia          | ✅          | ✅                 | ✅          |
+| Vicuna           | ✅          | ✅                 | ✅          |
 | Generic Text     | ✅          | ✅                 | ✅          |
 
 ### [Image Generation Prompt Templates](https://modelfusion.dev/guide/function/generate-image/prompt-format)

package/core/FunctionOptions.d.ts

@@ -31,14 +31,19 @@ export type FunctionOptions = {
     run?: Run;
     /**
      * Unique identifier of the call id of the parent function. Used in events and logging.
+     *
+     * It has the same name as the `callId` in `FunctionCallOptions` to allow for easy
+     * propagation of the call id.
+     *
+     * However, in the `FunctionOptions`, it is the call ID for the parent call, and it is optional.
      */
-    parentCallId?: string | undefined;
+    callId?: string | undefined;
 };
 /**
  * Extended options that are passed to models when functions are called. They are passed
  * into e.g. API providers to create custom headers.
  */
-export type FunctionCallOptions = Omit<FunctionOptions, "parentCallId"> & {
+export type FunctionCallOptions = Omit<FunctionOptions, "callId"> & {
     functionType: string;
     callId: string;
 };

package/core/executeFunction.cjs

@@ -7,13 +7,7 @@ async function executeFunction(fn, input, options) {
         options,
         input,
         functionType: "execute-function",
-        execute: async (options) => fn(input, {
-            // omit functionId
-            logging: options?.logging,
-            observers: options?.observers,
-            run: options?.run,
-            parentCallId: options?.parentCallId,
-        }),
+        execute: async (options) => fn(input, options),
     });
 }
 exports.executeFunction = executeFunction;

package/core/executeFunction.d.ts

@@ -1,2 +1,2 @@
-import { FunctionOptions } from "./FunctionOptions.js";
-export declare function executeFunction<INPUT, OUTPUT>(fn: (input: INPUT, options?: FunctionOptions) => PromiseLike<OUTPUT>, input: INPUT, options?: FunctionOptions): Promise<OUTPUT>;
+import { FunctionCallOptions, FunctionOptions } from "./FunctionOptions.js";
+export declare function executeFunction<INPUT, OUTPUT>(fn: (input: INPUT, options: FunctionCallOptions) => PromiseLike<OUTPUT>, input: INPUT, options?: FunctionOptions): Promise<OUTPUT>;

package/core/executeFunction.js

@@ -4,12 +4,6 @@ export async function executeFunction(fn, input, options) {
         options,
         input,
         functionType: "execute-function",
-        execute: async (options) => fn(input, {
-            // omit functionId
-            logging: options?.logging,
-            observers: options?.observers,
-            run: options?.run,
-            parentCallId: options?.parentCallId,
-        }),
+        execute: async (options) => fn(input, options),
     });
 }

package/core/executeFunctionCall.cjs

@@ -25,7 +25,7 @@ async function executeFunctionCall({ options, input, functionType, execute, inpu
     const startMetadata = {
         functionType,
         callId: `call-${(0, nanoid_1.nanoid)()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -39,11 +39,12 @@ async function executeFunctionCall({ options, input, functionType, execute, inpu
         ...startMetadata,
     });
     const result = await (0, runSafe_js_1.runSafe)(() => execute({
+        functionType,
         functionId: options?.functionId,
+        callId: startMetadata.callId,
         logging: options?.logging,
         observers: options?.observers,
         run,
-        parentCallId: startMetadata.callId,
     }));
     const finishMetadata = {
         eventType: "finished",

package/core/executeFunctionCall.d.ts

@@ -1,10 +1,10 @@
-import { FunctionOptions } from "./FunctionOptions.js";
+import { FunctionCallOptions, FunctionOptions } from "./FunctionOptions.js";
 import { FunctionEvent } from "./FunctionEvent.js";
 export declare function executeFunctionCall<VALUE>({ options, input, functionType, execute, inputPropertyName, outputPropertyName, }: {
     options?: FunctionOptions;
     input: unknown;
     functionType: FunctionEvent["functionType"];
-    execute: (options?: FunctionOptions) => PromiseLike<VALUE>;
+    execute: (options: FunctionCallOptions) => PromiseLike<VALUE>;
     inputPropertyName?: string;
     outputPropertyName?: string;
 }): Promise<VALUE>;

package/core/executeFunctionCall.js

@@ -22,7 +22,7 @@ export async function executeFunctionCall({ options, input, functionType, execut
     const startMetadata = {
         functionType,
         callId: `call-${createId()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -36,11 +36,12 @@ export async function executeFunctionCall({ options, input, functionType, execut
         ...startMetadata,
     });
     const result = await runSafe(() => execute({
+        functionType,
         functionId: options?.functionId,
+        callId: startMetadata.callId,
         logging: options?.logging,
         observers: options?.observers,
         run,
-        parentCallId: startMetadata.callId,
     }));
     const finishMetadata = {
         eventType: "finished",

package/core/getFunctionCallLogger.cjs

@@ -51,15 +51,30 @@ const detailedObjectObserver = {
             if (obj instanceof Date || typeof obj === "string") {
                 return obj;
             }
+            if (Array.isArray(obj)) {
+                return obj.map((item) => cleanObject(item));
+            }
             if (obj !== null && typeof obj === "object") {
                 return Object.fromEntries(Object.entries(obj)
-                    .filter(([_, v] // eslint-disable-line @typescript-eslint/no-unused-vars
-                ) => v !== undefined && // filter all undefined properties
-                    !(v instanceof Buffer) // remove all buffers
-                )
-                    .map(([k, v]) => [k, cleanObject(v)])
-                    .filter(([_, v]) => v !== undefined) // eslint-disable-line @typescript-eslint/no-unused-vars
-                );
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    .map(([k, v]) => {
+                    if (v === undefined) {
+                        return [k, undefined];
+                    }
+                    else if (v instanceof Buffer) {
+                        return [k, "omitted<Buffer>"];
+                    }
+                    else if (Array.isArray(v) &&
+                        v.length > 20 &&
+                        v.every((v) => typeof v === "number")) {
+                        return [k, "omitted<Array<number>>"];
+                    }
+                    else {
+                        return [k, cleanObject(v)];
+                    }
+                })
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    .filter(([_, v]) => v !== undefined));
             }
             return obj;
         }

package/core/getFunctionCallLogger.js

@@ -47,15 +47,30 @@ const detailedObjectObserver = {
             if (obj instanceof Date || typeof obj === "string") {
                 return obj;
             }
+            if (Array.isArray(obj)) {
+                return obj.map((item) => cleanObject(item));
+            }
             if (obj !== null && typeof obj === "object") {
                 return Object.fromEntries(Object.entries(obj)
-                    .filter(([_, v] // eslint-disable-line @typescript-eslint/no-unused-vars
-                ) => v !== undefined && // filter all undefined properties
-                    !(v instanceof Buffer) // remove all buffers
-                )
-                    .map(([k, v]) => [k, cleanObject(v)])
-                    .filter(([_, v]) => v !== undefined) // eslint-disable-line @typescript-eslint/no-unused-vars
-                );
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    .map(([k, v]) => {
+                    if (v === undefined) {
+                        return [k, undefined];
+                    }
+                    else if (v instanceof Buffer) {
+                        return [k, "omitted<Buffer>"];
+                    }
+                    else if (Array.isArray(v) &&
+                        v.length > 20 &&
+                        v.every((v) => typeof v === "number")) {
+                        return [k, "omitted<Array<number>>"];
+                    }
+                    else {
+                        return [k, cleanObject(v)];
+                    }
+                })
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    .filter(([_, v]) => v !== undefined));
             }
             return obj;
         }

package/model-function/executeStandardCall.cjs

@@ -27,7 +27,7 @@ async function executeStandardCall({ model, options, input, functionType, genera
     const startMetadata = {
         functionType,
         callId: `call-${(0, nanoid_1.nanoid)()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -43,7 +43,7 @@ async function executeStandardCall({ model, options, input, functionType, genera
         ...startMetadata,
     });
     const result = await (0, runSafe_js_1.runSafe)(() => generateResponse({
-        functionType: startMetadata.functionType,
+        functionType,
         functionId: options?.functionId,
         callId: startMetadata.callId,
         logging: options?.logging,

package/model-function/executeStandardCall.js

@@ -24,7 +24,7 @@ export async function executeStandardCall({ model, options, input, functionType,
     const startMetadata = {
         functionType,
         callId: `call-${createId()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -40,7 +40,7 @@ export async function executeStandardCall({ model, options, input, functionType,
         ...startMetadata,
     });
     const result = await runSafe(() => generateResponse({
-        functionType: startMetadata.functionType,
+        functionType,
         functionId: options?.functionId,
         callId: startMetadata.callId,
         logging: options?.logging,

package/model-function/executeStreamCall.cjs

@@ -28,7 +28,7 @@ async function executeStreamCall({ model, options, input, functionType, startStr
     const startMetadata = {
         functionType,
         callId: `call-${(0, nanoid_1.nanoid)()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -45,7 +45,7 @@ async function executeStreamCall({ model, options, input, functionType, startStr
     });
     const result = await (0, runSafe_js_1.runSafe)(async () => {
         const deltaIterable = await startStream({
-            functionType: startMetadata.functionType,
+            functionType,
             functionId: options?.functionId,
             callId: startMetadata.callId,
             logging: options?.logging,

package/model-function/executeStreamCall.js

@@ -25,7 +25,7 @@ export async function executeStreamCall({ model, options, input, functionType, s
     const startMetadata = {
         functionType,
         callId: `call-${createId()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -42,7 +42,7 @@ export async function executeStreamCall({ model, options, input, functionType, s
     });
     const result = await runSafe(async () => {
         const deltaIterable = await startStream({
-            functionType: startMetadata.functionType,
+            functionType,
             functionId: options?.functionId,
             callId: startMetadata.callId,
             logging: options?.logging,

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

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chat = exports.instruction = exports.text = void 0;
+const ContentPart_js_1 = require("./ContentPart.cjs");
+const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
+/**
+ * Formats a text prompt as a Synthia text prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * USER: text
+ * ASSISTANT:
+ * ```
+ */
+const text = () => ({
+    stopSequences: [],
+    format: (prompt) => `USER: ${prompt}\nASSISTANT: `,
+});
+exports.text = text;
+/**
+ * Formats an instruction prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: instruction
+ * ASSISTANT: response prefix
+ * ```
+ */
+const instruction = () => ({
+    stopSequences: [`\nUSER:`],
+    format(prompt) {
+        let text = prompt.system != null ? `SYSTEM: ${prompt.system}\n` : "";
+        text += `USER: ${(0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt)}\n`;
+        text += `ASSISTANT: ${prompt.responsePrefix ?? ""}`;
+        return text;
+    },
+});
+exports.instruction = instruction;
+/**
+ * Formats a chat prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: user message
+ * ASSISTANT: assistant message
+ * ```
+ */
+const chat = () => ({
+    format(prompt) {
+        let text = prompt.system != null ? `SYSTEM: ${prompt.system}\n` : "";
+        for (const { role, content } of prompt.messages) {
+            switch (role) {
+                case "user": {
+                    text += `USER: ${(0, ContentPart_js_1.validateContentIsString)(content, prompt)}\n`;
+                    break;
+                }
+                case "assistant": {
+                    text += `ASSISTANT: ${(0, ContentPart_js_1.validateContentIsString)(content, prompt)}\n`;
+                    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}`);
+                }
+            }
+        }
+        // Assistant message prefix:
+        text += `ASSISTANT: `;
+        return text;
+    },
+    stopSequences: [`\nUSER:`],
+});
+exports.chat = chat;

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

@@ -0,0 +1,35 @@
+import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
+import { ChatPrompt } from "./ChatPrompt.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+/**
+ * Formats a text prompt as a Synthia text prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * USER: text
+ * ASSISTANT:
+ * ```
+ */
+export declare const text: () => TextGenerationPromptTemplate<string, string>;
+/**
+ * Formats an instruction prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: instruction
+ * ASSISTANT: response prefix
+ * ```
+ */
+export declare const instruction: () => TextGenerationPromptTemplate<InstructionPrompt, string>;
+/**
+ * Formats a chat prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: user message
+ * ASSISTANT: assistant message
+ * ```
+ */
+export declare const chat: () => TextGenerationPromptTemplate<ChatPrompt, string>;

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

@@ -0,0 +1,72 @@
+import { validateContentIsString } from "./ContentPart.js";
+import { InvalidPromptError } from "./InvalidPromptError.js";
+/**
+ * Formats a text prompt as a Synthia text prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * USER: text
+ * ASSISTANT:
+ * ```
+ */
+export const text = () => ({
+    stopSequences: [],
+    format: (prompt) => `USER: ${prompt}\nASSISTANT: `,
+});
+/**
+ * Formats an instruction prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: instruction
+ * ASSISTANT: response prefix
+ * ```
+ */
+export const instruction = () => ({
+    stopSequences: [`\nUSER:`],
+    format(prompt) {
+        let text = prompt.system != null ? `SYSTEM: ${prompt.system}\n` : "";
+        text += `USER: ${validateContentIsString(prompt.instruction, prompt)}\n`;
+        text += `ASSISTANT: ${prompt.responsePrefix ?? ""}`;
+        return text;
+    },
+});
+/**
+ * Formats a chat prompt as a Synthia prompt.
+ *
+ * Synthia prompt template:
+ * ```
+ * SYSTEM: system message
+ * USER: user message
+ * ASSISTANT: assistant message
+ * ```
+ */
+export const chat = () => ({
+    format(prompt) {
+        let text = prompt.system != null ? `SYSTEM: ${prompt.system}\n` : "";
+        for (const { role, content } of prompt.messages) {
+            switch (role) {
+                case "user": {
+                    text += `USER: ${validateContentIsString(content, prompt)}\n`;
+                    break;
+                }
+                case "assistant": {
+                    text += `ASSISTANT: ${validateContentIsString(content, prompt)}\n`;
+                    break;
+                }
+                case "tool": {
+                    throw new InvalidPromptError("Tool messages are not supported.", prompt);
+                }
+                default: {
+                    const _exhaustiveCheck = role;
+                    throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
+                }
+            }
+        }
+        // Assistant message prefix:
+        text += `ASSISTANT: `;
+        return text;
+    },
+    stopSequences: [`\nUSER:`],
+});

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SynthiaPromptTemplate_js_1 = require("./SynthiaPromptTemplate.cjs");
+describe("text prompt", () => {
+    it("should format prompt", () => {
+        const prompt = (0, SynthiaPromptTemplate_js_1.text)().format("prompt");
+        expect(prompt).toMatchSnapshot();
+    });
+});
+describe("instruction prompt", () => {
+    it("should format prompt with instruction", () => {
+        const prompt = (0, SynthiaPromptTemplate_js_1.instruction)().format({
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with system and instruction", () => {
+        const prompt = (0, SynthiaPromptTemplate_js_1.instruction)().format({
+            system: "system",
+            instruction: "instruction",
+        });
+        expect(prompt).toMatchSnapshot();
+    });
+    it("should format prompt with instruction and response prefix", () => {
+        const prompt = (0, SynthiaPromptTemplate_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, SynthiaPromptTemplate_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, SynthiaPromptTemplate_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, SynthiaPromptTemplate_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/SynthiaPromptTemplate.test.d.ts

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

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

@@ -0,0 +1,58 @@
+import { chat, instruction, text } from "./SynthiaPromptTemplate.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/VicunaPromptTemplate.cjs

@@ -25,19 +25,17 @@ exports.text = text;
 /**
  * Formats an instruction prompt as a Vicuna prompt.
  */
-function instruction() {
-    return {
-        format(prompt) {
-            let text = prompt.system != null
-                ? `${prompt.system}\n\n`
-                : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
-            text += `USER: ${(0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt)}\n`;
-            text += `ASSISTANT: `;
-            return text;
-        },
-        stopSequences: [`\nUSER:`],
-    };
-}
+const instruction = () => ({
+    stopSequences: [`\nUSER:`],
+    format(prompt) {
+        let text = prompt.system != null
+            ? `${prompt.system}\n\n`
+            : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
+        text += `USER: ${(0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt)}\n`;
+        text += `ASSISTANT: `;
+        return text;
+    },
+});
 exports.instruction = instruction;
 /**
  * Formats a chat prompt as a Vicuna prompt.

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

@@ -8,7 +8,7 @@ export declare function text(): TextGenerationPromptTemplate<string, string>;
 /**
  * Formats an instruction prompt as a Vicuna prompt.
  */
-export declare function instruction(): TextGenerationPromptTemplate<InstructionPrompt, string>;
+export declare const instruction: () => TextGenerationPromptTemplate<InstructionPrompt, string>;
 /**
  * Formats a chat prompt as a Vicuna prompt.
  *

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

@@ -21,19 +21,17 @@ export function text() {
 /**
  * Formats an instruction prompt as a Vicuna prompt.
  */
-export function instruction() {
-    return {
-        format(prompt) {
-            let text = prompt.system != null
-                ? `${prompt.system}\n\n`
-                : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
-            text += `USER: ${validateContentIsString(prompt.instruction, prompt)}\n`;
-            text += `ASSISTANT: `;
-            return text;
-        },
-        stopSequences: [`\nUSER:`],
-    };
-}
+export const instruction = () => ({
+    stopSequences: [`\nUSER:`],
+    format(prompt) {
+        let text = prompt.system != null
+            ? `${prompt.system}\n\n`
+            : `${DEFAULT_SYSTEM_MESSAGE}\n\n`;
+        text += `USER: ${validateContentIsString(prompt.instruction, prompt)}\n`;
+        text += `ASSISTANT: `;
+        return text;
+    },
+});
 /**
  * Formats a chat prompt as a Vicuna prompt.
  *

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

@@ -26,7 +26,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 });
-exports.VicunaPrompt = exports.TextPrompt = exports.NeuralChatPrompt = exports.MistralInstructPrompt = exports.Llama2Prompt = exports.ChatMLPrompt = exports.AlpacaPrompt = void 0;
+exports.VicunaPrompt = exports.TextPrompt = exports.SynthiaPrompt = exports.NeuralChatPrompt = exports.MistralInstructPrompt = exports.Llama2Prompt = exports.ChatMLPrompt = exports.AlpacaPrompt = void 0;
 exports.AlpacaPrompt = __importStar(require("./AlpacaPromptTemplate.cjs"));
 exports.ChatMLPrompt = __importStar(require("./ChatMLPromptTemplate.cjs"));
 __exportStar(require("./ChatPrompt.cjs"), exports);
@@ -37,6 +37,7 @@ exports.Llama2Prompt = __importStar(require("./Llama2PromptTemplate.cjs"));
 exports.MistralInstructPrompt = __importStar(require("./MistralInstructPromptTemplate.cjs"));
 exports.NeuralChatPrompt = __importStar(require("./NeuralChatPromptTemplate.cjs"));
 __exportStar(require("./PromptTemplateProvider.cjs"), exports);
+exports.SynthiaPrompt = __importStar(require("./SynthiaPromptTemplate.cjs"));
 exports.TextPrompt = __importStar(require("./TextPromptTemplate.cjs"));
 exports.VicunaPrompt = __importStar(require("./VicunaPromptTemplate.cjs"));
 __exportStar(require("./trimChatPrompt.cjs"), exports);

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

@@ -8,6 +8,7 @@ export * as Llama2Prompt from "./Llama2PromptTemplate.js";
 export * as MistralInstructPrompt from "./MistralInstructPromptTemplate.js";
 export * as NeuralChatPrompt from "./NeuralChatPromptTemplate.js";
 export * from "./PromptTemplateProvider.js";
+export * as SynthiaPrompt from "./SynthiaPromptTemplate.js";
 export * as TextPrompt from "./TextPromptTemplate.js";
 export * as VicunaPrompt from "./VicunaPromptTemplate.js";
 export * from "./trimChatPrompt.js";

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

@@ -8,6 +8,7 @@ export * as Llama2Prompt from "./Llama2PromptTemplate.js";
 export * as MistralInstructPrompt from "./MistralInstructPromptTemplate.js";
 export * as NeuralChatPrompt from "./NeuralChatPromptTemplate.js";
 export * from "./PromptTemplateProvider.js";
+export * as SynthiaPrompt from "./SynthiaPromptTemplate.js";
 export * as TextPrompt from "./TextPromptTemplate.js";
 export * as VicunaPrompt from "./VicunaPromptTemplate.js";
 export * from "./trimChatPrompt.js";

package/model-provider/llamacpp/LlamaCppPrompt.cjs

@@ -23,12 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BakLLaVA1 = exports.Vicuna = exports.Alpaca = exports.NeuralChat = exports.Llama2 = exports.ChatML = exports.Mistral = exports.Text = exports.asLlamaCppTextPromptTemplateProvider = exports.asLlamaCppPromptTemplate = void 0;
+exports.BakLLaVA1 = exports.Vicuna = exports.Synthia = exports.Alpaca = exports.NeuralChat = exports.Llama2 = exports.ChatML = exports.Mistral = exports.Text = exports.asLlamaCppTextPromptTemplateProvider = exports.asLlamaCppPromptTemplate = void 0;
 const alpacaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/AlpacaPromptTemplate.cjs"));
 const chatMlPrompt = __importStar(require("../../model-function/generate-text/prompt-template/ChatMLPromptTemplate.cjs"));
 const llama2Prompt = __importStar(require("../../model-function/generate-text/prompt-template/Llama2PromptTemplate.cjs"));
 const mistralPrompt = __importStar(require("../../model-function/generate-text/prompt-template/MistralInstructPromptTemplate.cjs"));
 const neuralChatPrompt = __importStar(require("../../model-function/generate-text/prompt-template/NeuralChatPromptTemplate.cjs"));
+const synthiaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/SynthiaPromptTemplate.cjs"));
 const textPrompt = __importStar(require("../../model-function/generate-text/prompt-template/TextPromptTemplate.cjs"));
 const vicunaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/VicunaPromptTemplate.cjs"));
 const LlamaCppBakLLaVA1Prompt = __importStar(require("./LlamaCppBakLLaVA1PromptTemplate.cjs"));
@@ -87,5 +88,6 @@ exports.ChatML = asLlamaCppTextPromptTemplateProvider(chatMlPrompt);
 exports.Llama2 = asLlamaCppTextPromptTemplateProvider(llama2Prompt);
 exports.NeuralChat = asLlamaCppTextPromptTemplateProvider(neuralChatPrompt);
 exports.Alpaca = asLlamaCppTextPromptTemplateProvider(alpacaPrompt);
+exports.Synthia = asLlamaCppTextPromptTemplateProvider(synthiaPrompt);
 exports.Vicuna = asLlamaCppTextPromptTemplateProvider(vicunaPrompt);
 exports.BakLLaVA1 = LlamaCppBakLLaVA1Prompt;

package/model-provider/llamacpp/LlamaCppPrompt.d.ts

@@ -42,5 +42,6 @@ export declare const ChatML: TextGenerationPromptTemplateProvider<LlamaCppComple
 export declare const Llama2: TextGenerationPromptTemplateProvider<LlamaCppCompletionPrompt>;
 export declare const NeuralChat: TextGenerationPromptTemplateProvider<LlamaCppCompletionPrompt>;
 export declare const Alpaca: TextGenerationPromptTemplateProvider<LlamaCppCompletionPrompt>;
+export declare const Synthia: TextGenerationPromptTemplateProvider<LlamaCppCompletionPrompt>;
 export declare const Vicuna: TextGenerationPromptTemplateProvider<LlamaCppCompletionPrompt>;
 export declare const BakLLaVA1: typeof LlamaCppBakLLaVA1Prompt;

package/model-provider/llamacpp/LlamaCppPrompt.js

@@ -3,6 +3,7 @@ import * as chatMlPrompt from "../../model-function/generate-text/prompt-templat
 import * as llama2Prompt from "../../model-function/generate-text/prompt-template/Llama2PromptTemplate.js";
 import * as mistralPrompt from "../../model-function/generate-text/prompt-template/MistralInstructPromptTemplate.js";
 import * as neuralChatPrompt from "../../model-function/generate-text/prompt-template/NeuralChatPromptTemplate.js";
+import * as synthiaPrompt from "../../model-function/generate-text/prompt-template/SynthiaPromptTemplate.js";
 import * as textPrompt from "../../model-function/generate-text/prompt-template/TextPromptTemplate.js";
 import * as vicunaPrompt from "../../model-function/generate-text/prompt-template/VicunaPromptTemplate.js";
 import * as LlamaCppBakLLaVA1Prompt from "./LlamaCppBakLLaVA1PromptTemplate.js";
@@ -59,5 +60,6 @@ export const ChatML = asLlamaCppTextPromptTemplateProvider(chatMlPrompt);
 export const Llama2 = asLlamaCppTextPromptTemplateProvider(llama2Prompt);
 export const NeuralChat = asLlamaCppTextPromptTemplateProvider(neuralChatPrompt);
 export const Alpaca = asLlamaCppTextPromptTemplateProvider(alpacaPrompt);
+export const Synthia = asLlamaCppTextPromptTemplateProvider(synthiaPrompt);
 export const Vicuna = asLlamaCppTextPromptTemplateProvider(vicunaPrompt);
 export const BakLLaVA1 = LlamaCppBakLLaVA1Prompt;

package/model-provider/ollama/OllamaCompletionPrompt.cjs

@@ -23,12 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vicuna = exports.Alpaca = exports.NeuralChat = exports.Llama2 = exports.ChatML = exports.Mistral = exports.Text = exports.asOllamaCompletionTextPromptTemplateProvider = exports.asOllamaCompletionPromptTemplate = void 0;
+exports.Vicuna = exports.Synthia = exports.Alpaca = exports.NeuralChat = exports.Llama2 = exports.ChatML = exports.Mistral = exports.Text = exports.asOllamaCompletionTextPromptTemplateProvider = exports.asOllamaCompletionPromptTemplate = void 0;
 const alpacaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/AlpacaPromptTemplate.cjs"));
 const chatMlPrompt = __importStar(require("../../model-function/generate-text/prompt-template/ChatMLPromptTemplate.cjs"));
 const llama2Prompt = __importStar(require("../../model-function/generate-text/prompt-template/Llama2PromptTemplate.cjs"));
 const mistralPrompt = __importStar(require("../../model-function/generate-text/prompt-template/MistralInstructPromptTemplate.cjs"));
 const neuralChatPrompt = __importStar(require("../../model-function/generate-text/prompt-template/NeuralChatPromptTemplate.cjs"));
+const synthiaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/SynthiaPromptTemplate.cjs"));
 const textPrompt = __importStar(require("../../model-function/generate-text/prompt-template/TextPromptTemplate.cjs"));
 const vicunaPrompt = __importStar(require("../../model-function/generate-text/prompt-template/VicunaPromptTemplate.cjs"));
 function asOllamaCompletionPromptTemplate(promptTemplate) {
@@ -86,4 +87,5 @@ exports.ChatML = asOllamaCompletionTextPromptTemplateProvider(chatMlPrompt);
 exports.Llama2 = asOllamaCompletionTextPromptTemplateProvider(llama2Prompt);
 exports.NeuralChat = asOllamaCompletionTextPromptTemplateProvider(neuralChatPrompt);
 exports.Alpaca = asOllamaCompletionTextPromptTemplateProvider(alpacaPrompt);
+exports.Synthia = asOllamaCompletionTextPromptTemplateProvider(synthiaPrompt);
 exports.Vicuna = asOllamaCompletionTextPromptTemplateProvider(vicunaPrompt);

package/model-provider/ollama/OllamaCompletionPrompt.d.ts

@@ -41,4 +41,5 @@ export declare const ChatML: TextGenerationPromptTemplateProvider<OllamaCompleti
 export declare const Llama2: TextGenerationPromptTemplateProvider<OllamaCompletionPrompt>;
 export declare const NeuralChat: TextGenerationPromptTemplateProvider<OllamaCompletionPrompt>;
 export declare const Alpaca: TextGenerationPromptTemplateProvider<OllamaCompletionPrompt>;
+export declare const Synthia: TextGenerationPromptTemplateProvider<OllamaCompletionPrompt>;
 export declare const Vicuna: TextGenerationPromptTemplateProvider<OllamaCompletionPrompt>;

package/model-provider/ollama/OllamaCompletionPrompt.js

@@ -3,6 +3,7 @@ import * as chatMlPrompt from "../../model-function/generate-text/prompt-templat
 import * as llama2Prompt from "../../model-function/generate-text/prompt-template/Llama2PromptTemplate.js";
 import * as mistralPrompt from "../../model-function/generate-text/prompt-template/MistralInstructPromptTemplate.js";
 import * as neuralChatPrompt from "../../model-function/generate-text/prompt-template/NeuralChatPromptTemplate.js";
+import * as synthiaPrompt from "../../model-function/generate-text/prompt-template/SynthiaPromptTemplate.js";
 import * as textPrompt from "../../model-function/generate-text/prompt-template/TextPromptTemplate.js";
 import * as vicunaPrompt from "../../model-function/generate-text/prompt-template/VicunaPromptTemplate.js";
 export function asOllamaCompletionPromptTemplate(promptTemplate) {
@@ -58,4 +59,5 @@ export const ChatML = asOllamaCompletionTextPromptTemplateProvider(chatMlPrompt)
 export const Llama2 = asOllamaCompletionTextPromptTemplateProvider(llama2Prompt);
 export const NeuralChat = asOllamaCompletionTextPromptTemplateProvider(neuralChatPrompt);
 export const Alpaca = asOllamaCompletionTextPromptTemplateProvider(alpacaPrompt);
+export const Synthia = asOllamaCompletionTextPromptTemplateProvider(synthiaPrompt);
 export const Vicuna = asOllamaCompletionTextPromptTemplateProvider(vicunaPrompt);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building AI applications.",
-  "version": "0.120.0",
+  "version": "0.121.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/tool/Tool.d.ts

@@ -1,4 +1,4 @@
-import { FunctionOptions } from "../core/FunctionOptions.js";
+import { FunctionCallOptions, FunctionOptions } from "../core/FunctionOptions.js";
 import { JsonSchemaProducer } from "../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../core/schema/Schema.js";
 import { ToolDefinition } from "./ToolDefinition.js";
@@ -28,7 +28,7 @@ export declare class Tool<NAME extends string, PARAMETERS, RESULT> implements To
     /**
      * The actual execution function of the tool.
      */
-    readonly execute: (args: PARAMETERS, options?: FunctionOptions) => PromiseLike<RESULT>;
+    readonly execute: (args: PARAMETERS, options: FunctionCallOptions) => PromiseLike<RESULT>;
     constructor({ name, description, parameters, returnType, execute, }: {
         name: NAME;
         description: string;

package/tool/execute-tool/executeTool.cjs

@@ -32,7 +32,7 @@ async function doExecuteTool(tool, args, options) {
     const metadata = {
         functionType: "execute-tool",
         callId: `call-${(0, nanoid_1.nanoid)()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -47,11 +47,12 @@ async function doExecuteTool(tool, args, options) {
         startTimestamp: durationMeasurement.startDate,
     });
     const result = await (0, runSafe_js_1.runSafe)(() => tool.execute(args, {
+        functionType: metadata.functionType,
+        callId: metadata.callId,
         functionId: options?.functionId,
         logging: options?.logging,
         observers: options?.observers,
         run,
-        parentCallId: metadata.callId,
     }));
     const finishMetadata = {
         ...metadata,

package/tool/execute-tool/executeTool.js

@@ -28,7 +28,7 @@ async function doExecuteTool(tool, args, options) {
     const metadata = {
         functionType: "execute-tool",
         callId: `call-${createId()}`,
-        parentCallId: options?.parentCallId,
+        parentCallId: options?.callId,
         runId: run?.runId,
         sessionId: run?.sessionId,
         userId: run?.userId,
@@ -43,11 +43,12 @@ async function doExecuteTool(tool, args, options) {
         startTimestamp: durationMeasurement.startDate,
     });
     const result = await runSafe(() => tool.execute(args, {
+        functionType: metadata.functionType,
+        callId: metadata.callId,
         functionId: options?.functionId,
         logging: options?.logging,
         observers: options?.observers,
         run,
-        parentCallId: metadata.callId,
     }));
     const finishMetadata = {
         ...metadata,