modelfusion 0.73.1 → 0.74.1

package/README.md

@@ -32,7 +32,11 @@
 npm install modelfusion
 ```
 
-Or use a template: [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
+Or use a template:
+
+- [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
+- [Next.js, Vercel AI SDK, Llama.cpp & ModelFusion starter](https://github.com/lgrammel/modelfusion-llamacpp-nextjs-starter)
+- [Next.js, Vercel AI SDK, Ollama & ModelFusion starter](https://github.com/lgrammel/modelfusion-ollama-nextjs-starter)
 
 ## Usage Examples
 
@@ -475,11 +479,22 @@ const retrievedTexts = await retrieve(
 
 Available Vector Stores: [Memory](https://modelfusion.dev/integration/vector-index/memory), [SQLite VSS](https://modelfusion.dev/integration/vector-index/sqlite-vss), [Pinecone](https://modelfusion.dev/integration/vector-index/pinecone)
 
-### Prompt Formats
+### [Text Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-text#prompt-format)
 
-Prompt formats let you use higher level prompt structures (such as instruction or chat prompts) for different models.
+Prompt formats let you use higher level prompt structures (such as text, instruction or chat prompts) for different models.
 
-#### [Text Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-text#prompt-format)
+#### Text Prompt Example
+
+```ts
+const text = await generateText(
+  new AnthropicTextGenerationModel({
+    model: "claude-instant-1",
+  }).withTextPrompt(),
+  "Write a short story about a robot learning to love"
+);
+```
+
+#### Instruction Prompt Example
 
 ```ts
 // example assumes you are running https://huggingface.co/TheBloke/Llama-2-7B-GGUF with llama.cpp
@@ -487,9 +502,7 @@ const text = await generateText(
   new LlamaCppTextGenerationModel({
     contextWindowSize: 4096, // Llama 2 context window size
     maxCompletionTokens: 1000,
-  })
-    .withTextPrompt() // pure text prompt (no images)
-    .withPromptFormat(Llama2PromptFormat.instruction()),
+  }).withTextPromptFormat(Llama2PromptFormat.instruction()),
   {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
@@ -497,7 +510,9 @@ const text = await generateText(
 );
 ```
 
-They can also be accessed through the shorthand methods `.withChatPrompt()` and `.withInstructionPrompt()` for many models:
+They can also be accessed through the shorthand methods `.withTextPrompt()`, `.withChatPrompt()` and `.withInstructionPrompt()` for many models:
+
+#### Chat Prompt Example
 
 ```ts
 const textStream = await streamText(
@@ -524,19 +539,17 @@ const textStream = await streamText(
 );
 ```
 
-| Prompt Format | Instruction Prompt | Chat Prompt |
-| ------------- | ------------------ | ----------- |
-| OpenAI Chat   | ✅                 | ✅          |
-| Anthropic     | ✅                 | ✅          |
-| Llama 2       | ✅                 | ✅          |
-| ChatML        | ✅                 | ✅          |
-| Alpaca        | ✅                 | ❌          |
-| Vicuna        | ❌                 | ✅          |
-| Generic Text  | ✅                 | ✅          |
-
-#### [Vision Prompts]
-
-#### [Image Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-image/prompt-format)
+| Prompt Format | Text Prompt | Instruction Prompt | Chat Prompt |
+| ------------- | ----------- | ------------------ | ----------- |
+| OpenAI Chat   | ✅          | ✅                 | ✅          |
+| Anthropic     | ✅          | ✅                 | ✅          |
+| Llama 2       | ✅          | ✅                 | ✅          |
+| ChatML        | ✅          | ✅                 | ✅          |
+| Alpaca        | ✅          | ✅                 | ❌          |
+| Vicuna        | ❌          | ❌                 | ✅          |
+| Generic Text  | ✅          | ✅                 | ✅          |
+
+### [Image Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-image/prompt-format)
 
 You an use prompt formats with image models as well, e.g. to use a basic text prompt. It is available as a shorthand method:
 

package/core/api/retryWithExponentialBackoff.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.retryWithExponentialBackoff = void 0;
 const delay_js_1 = require("../../util/delay.cjs");
+const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
 const ApiCallError_js_1 = require("./ApiCallError.cjs");
 const RetryError_js_1 = require("./RetryError.cjs");
 /**
@@ -19,11 +20,12 @@ async function _retryWithExponentialBackoff(f, { maxTries, delayInMs, backoffFac
         return await f();
     }
     catch (error) {
+        const errorMessage = (0, getErrorMessage_js_1.getErrorMessage)(error);
         const newErrors = [...errors, error];
         const tryNumber = newErrors.length;
         if (tryNumber >= maxTries) {
             throw new RetryError_js_1.RetryError({
-                message: `Failed after ${tryNumber} tries.`,
+                message: `Failed after ${tryNumber} tries. Last error: ${errorMessage}`,
                 reason: "maxTriesExceeded",
                 errors: newErrors,
             });
@@ -39,7 +41,6 @@ async function _retryWithExponentialBackoff(f, { maxTries, delayInMs, backoffFac
                 return _retryWithExponentialBackoff(f, { maxTries, delayInMs: backoffFactor * delayInMs, backoffFactor }, newErrors);
             }
         }
-        const errorMessage = error instanceof Error ? error.message : String(error);
         throw new RetryError_js_1.RetryError({
             message: `Failed after ${tryNumber} attempt(s) with non-retryable error: '${errorMessage}'`,
             reason: "errorNotRetryable",

package/core/api/retryWithExponentialBackoff.js

@@ -1,4 +1,5 @@
 import { delay } from "../../util/delay.js";
+import { getErrorMessage } from "../../util/getErrorMessage.js";
 import { ApiCallError } from "./ApiCallError.js";
 import { RetryError } from "./RetryError.js";
 /**
@@ -15,11 +16,12 @@ async function _retryWithExponentialBackoff(f, { maxTries, delayInMs, backoffFac
         return await f();
     }
     catch (error) {
+        const errorMessage = getErrorMessage(error);
         const newErrors = [...errors, error];
         const tryNumber = newErrors.length;
         if (tryNumber >= maxTries) {
             throw new RetryError({
-                message: `Failed after ${tryNumber} tries.`,
+                message: `Failed after ${tryNumber} tries. Last error: ${errorMessage}`,
                 reason: "maxTriesExceeded",
                 errors: newErrors,
             });
@@ -35,7 +37,6 @@ async function _retryWithExponentialBackoff(f, { maxTries, delayInMs, backoffFac
                 return _retryWithExponentialBackoff(f, { maxTries, delayInMs: backoffFactor * delayInMs, backoffFactor }, newErrors);
             }
         }
-        const errorMessage = error instanceof Error ? error.message : String(error);
         throw new RetryError({
             message: `Failed after ${tryNumber} attempt(s) with non-retryable error: '${errorMessage}'`,
             reason: "errorNotRetryable",

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

@@ -1,8 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instruction = void 0;
+exports.instruction = exports.text = 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.";
+/**
+ * Formats a text prompt as an Alpaca prompt.
+ */
+function text() {
+    return {
+        stopSequences: [],
+        format: (instruction) => {
+            let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
+            text += "\n\n### Instruction:\n";
+            text += instruction;
+            text += "\n\n### Response:\n";
+            return text;
+        },
+    };
+}
+exports.text = text;
 /**
  * Formats an instruction prompt as an Alpaca prompt.
  *

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

@@ -1,5 +1,9 @@
 import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+/**
+ * Formats a text prompt as an Alpaca prompt.
+ */
+export declare function text(): TextGenerationPromptFormat<string, string>;
 /**
  * Formats an instruction prompt as an Alpaca prompt.
  *
@@ -36,4 +40,7 @@ import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt, string>;
+export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt & {
+    input?: string;
+}, // optional input supported by Alpaca
+string>;

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

@@ -1,5 +1,20 @@
 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.";
+/**
+ * Formats a text prompt as an Alpaca prompt.
+ */
+export function text() {
+    return {
+        stopSequences: [],
+        format: (instruction) => {
+            let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
+            text += "\n\n### Instruction:\n";
+            text += instruction;
+            text += "\n\n### Response:\n";
+            return text;
+        },
+    };
+}
 /**
  * Formats an instruction prompt as an Alpaca prompt.
  *

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = void 0;
+exports.chat = exports.instruction = exports.text = void 0;
 const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
 const START_SEGMENT = "<|im_start|>";
 const END_SEGMENT = "<|im_end|>";
@@ -10,6 +10,16 @@ function chatMLStart(role) {
 function chatMLSegment(role, text) {
     return text == null ? "" : `${chatMLStart(role)}${text}${END_SEGMENT}\n`;
 }
+/**
+ * Formats a text prompt using the ChatML format.
+ */
+function text() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => chatMLSegment("user", instruction),
+    };
+}
+exports.text = text;
 /**
  * Formats an instruction prompt using the ChatML format.
  *
@@ -27,9 +37,7 @@ function instruction() {
     return {
         stopSequences: [END_SEGMENT],
         format: (instruction) => chatMLSegment("system", instruction.system) +
-            chatMLSegment("user", instruction.instruction + instruction.input != null
-                ? `\n\n${instruction.input}`
-                : ""),
+            chatMLSegment("user", instruction.instruction),
     };
 }
 exports.instruction = instruction;

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

@@ -1,6 +1,10 @@
 import { ChatPrompt } from "./ChatPrompt.js";
 import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+/**
+ * Formats a text prompt using the ChatML format.
+ */
+export declare function text(): TextGenerationPromptFormat<string, string>;
 /**
  * Formats an instruction prompt using the ChatML format.
  *

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

@@ -7,6 +7,15 @@ function chatMLStart(role) {
 function chatMLSegment(role, text) {
     return text == null ? "" : `${chatMLStart(role)}${text}${END_SEGMENT}\n`;
 }
+/**
+ * Formats a text prompt using the ChatML format.
+ */
+export function text() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => chatMLSegment("user", instruction),
+    };
+}
 /**
  * Formats an instruction prompt using the ChatML format.
  *
@@ -24,9 +33,7 @@ export function instruction() {
     return {
         stopSequences: [END_SEGMENT],
         format: (instruction) => chatMLSegment("system", instruction.system) +
-            chatMLSegment("user", instruction.instruction + instruction.input != null
-                ? `\n\n${instruction.input}`
-                : ""),
+            chatMLSegment("user", instruction.instruction),
     };
 }
 /**

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

@@ -1,13 +1,11 @@
 /**
- * A single instruction prompt. It can contain an optional system message to define the role and behavior of the language model
- * and an optiona input to provide context for the language model.
+ * A single instruction prompt. It can contain an optional system message to define the role and behavior of the language model.
  *
  * @example
  * ```ts
  * {
  *   system: "You are a celebrated poet.", // optional
- *   instruction: "Write a short story about:",
- *   input: "a robot learning to love.", // optional
+ *   instruction: "Write a story about a robot learning to love",
  * }
  * ```
  */
@@ -21,10 +19,6 @@ export type InstructionPrompt = {
      * The instruction for the model.
      */
     instruction: string;
-    /**
-     * Optional additional input or context, e.g. a the content from which information should be extracted.
-     */
-    input?: string;
     /**
      * Optional image to provide context for the language model. Only supported by some models.
      */

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = void 0;
+exports.chat = exports.instruction = exports.text = void 0;
 const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
@@ -9,6 +9,23 @@ const BEGIN_INSTRUCTION = "[INST]";
 const END_INSTRUCTION = "[/INST]";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
+/**
+ * Formats a text prompt as a Llama 2 prompt.
+ *
+ * Llama 2 prompt template:
+ * ```
+ * <s>[INST]{ instruction } [/INST]
+ * ```
+ *
+ * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
+ */
+function text() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction}${END_INSTRUCTION}\n`,
+    };
+}
+exports.text = text;
 /**
  * Formats an instruction prompt as a Llama 2 prompt.
  *
@@ -28,7 +45,7 @@ function instruction() {
         stopSequences: [END_SEGMENT],
         format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
             ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-            : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
+            : ""}${instruction.instruction}${END_INSTRUCTION}\n`,
     };
 }
 exports.instruction = instruction;

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

@@ -1,6 +1,17 @@
 import { ChatPrompt } from "./ChatPrompt.js";
 import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+/**
+ * Formats a text prompt as a Llama 2 prompt.
+ *
+ * Llama 2 prompt template:
+ * ```
+ * <s>[INST]{ instruction } [/INST]
+ * ```
+ *
+ * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
+ */
+export declare function text(): TextGenerationPromptFormat<string, string>;
 /**
  * Formats an instruction prompt as a Llama 2 prompt.
  *

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

@@ -6,6 +6,22 @@ const BEGIN_INSTRUCTION = "[INST]";
 const END_INSTRUCTION = "[/INST]";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
+/**
+ * Formats a text prompt as a Llama 2 prompt.
+ *
+ * Llama 2 prompt template:
+ * ```
+ * <s>[INST]{ instruction } [/INST]
+ * ```
+ *
+ * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
+ */
+export function text() {
+    return {
+        stopSequences: [END_SEGMENT],
+        format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction}${END_INSTRUCTION}\n`,
+    };
+}
 /**
  * Formats an instruction prompt as a Llama 2 prompt.
  *
@@ -25,7 +41,7 @@ export function instruction() {
         stopSequences: [END_SEGMENT],
         format: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
             ? ` ${BEGIN_SYSTEM}${instruction.system}${END_SYSTEM}`
-            : ""} ${instruction.instruction}${instruction.input != null ? `\n\n${instruction.input}` : ""} ${END_INSTRUCTION}\n`,
+            : ""}${instruction.instruction}${END_INSTRUCTION}\n`,
     };
 }
 /**

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

@@ -1,7 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = void 0;
+exports.chat = exports.instruction = exports.text = void 0;
 const validateChatPrompt_js_1 = require("./validateChatPrompt.cjs");
+/**
+ * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
+ */
+const text = () => ({
+    stopSequences: [],
+    format: (instruction) => instruction,
+});
+exports.text = text;
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
@@ -13,9 +21,6 @@ const instruction = () => ({
             text += `${instruction.system}\n\n`;
         }
         text += instruction.instruction;
-        if (instruction.input != null) {
-            text += `\n\n${instruction.input}`;
-        }
         return text;
     },
 });

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

@@ -1,6 +1,10 @@
 import { ChatPrompt } from "./ChatPrompt.js";
 import { InstructionPrompt } from "./InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../TextGenerationPromptFormat.js";
+/**
+ * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
+ */
+export declare const text: () => TextGenerationPromptFormat<string, string>;
 /**
  * Formats an instruction prompt as a basic text prompt.
  */

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

@@ -1,4 +1,11 @@
 import { validateChatPrompt } from "./validateChatPrompt.js";
+/**
+ * Formats a text prompt as a basic text prompt. Does not change the text prompt in any way.
+ */
+export const text = () => ({
+    stopSequences: [],
+    format: (instruction) => instruction,
+});
 /**
  * Formats an instruction prompt as a basic text prompt.
  */
@@ -10,9 +17,6 @@ export const instruction = () => ({
             text += `${instruction.system}\n\n`;
         }
         text += instruction.instruction;
-        if (instruction.input != null) {
-            text += `\n\n${instruction.input}`;
-        }
         return text;
     },
 });

package/model-provider/anthropic/AnthropicPromptFormat.cjs

@@ -1,7 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = void 0;
+exports.chat = exports.instruction = exports.text = void 0;
 const validateChatPrompt_js_1 = require("../../model-function/generate-text/prompt-format/validateChatPrompt.cjs");
+/**
+ * Formats a text prompt as an Anthropic prompt.
+ */
+function text() {
+    return {
+        format: (instruction) => {
+            let text = "";
+            text += "\n\nHuman:";
+            text += instruction;
+            text += "\n\nAssistant:";
+            return text;
+        },
+        stopSequences: [],
+    };
+}
+exports.text = text;
 /**
  * Formats an instruction prompt as an Anthropic prompt.
  */
@@ -14,11 +30,6 @@ function instruction() {
             }
             text += "\n\nHuman:";
             text += instruction.instruction;
-            if (instruction.input != null) {
-                // use tags per Anthropic instruction:
-                // https://docs.anthropic.com/claude/docs/constructing-a-prompt
-                text += `\n\n<data>${instruction.input}</data>`;
-            }
             text += "\n\nAssistant:";
             return text;
         },

package/model-provider/anthropic/AnthropicPromptFormat.d.ts

@@ -1,6 +1,10 @@
 import { ChatPrompt } from "../../model-function/generate-text/prompt-format/ChatPrompt.js";
 import { InstructionPrompt } from "../../model-function/generate-text/prompt-format/InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../../model-function/generate-text/TextGenerationPromptFormat.js";
+/**
+ * Formats a text prompt as an Anthropic prompt.
+ */
+export declare function text(): TextGenerationPromptFormat<string, string>;
 /**
  * Formats an instruction prompt as an Anthropic prompt.
  */

package/model-provider/anthropic/AnthropicPromptFormat.js

@@ -1,4 +1,19 @@
 import { validateChatPrompt } from "../../model-function/generate-text/prompt-format/validateChatPrompt.js";
+/**
+ * Formats a text prompt as an Anthropic prompt.
+ */
+export function text() {
+    return {
+        format: (instruction) => {
+            let text = "";
+            text += "\n\nHuman:";
+            text += instruction;
+            text += "\n\nAssistant:";
+            return text;
+        },
+        stopSequences: [],
+    };
+}
 /**
  * Formats an instruction prompt as an Anthropic prompt.
  */
@@ -11,11 +26,6 @@ export function instruction() {
             }
             text += "\n\nHuman:";
             text += instruction.instruction;
-            if (instruction.input != null) {
-                // use tags per Anthropic instruction:
-                // https://docs.anthropic.com/claude/docs/constructing-a-prompt
-                text += `\n\n<data>${instruction.input}</data>`;
-            }
             text += "\n\nAssistant:";
             return text;
         },

package/model-provider/anthropic/AnthropicTextGenerationModel.cjs

@@ -106,6 +106,12 @@ class AnthropicTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             responseFormat: exports.AnthropicTextGenerationResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat((0, AnthropicPromptFormat_js_1.text)());
+    }
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/anthropic/AnthropicTextGenerationModel.d.ts

@@ -55,6 +55,10 @@ export declare class AnthropicTextGenerationModel extends AbstractModel<Anthropi
         text: string;
     }>;
     doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt(): PromptFormatTextStreamingModel<string, string, AnthropicTextGenerationModelSettings, this>;
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/anthropic/AnthropicTextGenerationModel.js

@@ -9,7 +9,7 @@ import { ZodSchema } from "../../core/schema/ZodSchema.js";
 import { parseJSON } from "../../core/schema/parseJSON.js";
 import { AnthropicApiConfiguration } from "./AnthropicApiConfiguration.js";
 import { failedAnthropicCallResponseHandler } from "./AnthropicError.js";
-import { instruction, chat } from "./AnthropicPromptFormat.js";
+import { instruction, chat, text } from "./AnthropicPromptFormat.js";
 export const ANTHROPIC_TEXT_GENERATION_MODELS = {
     "claude-instant-1": {
         contextWindowSize: 100000,
@@ -103,6 +103,12 @@ export class AnthropicTextGenerationModel extends AbstractModel {
             responseFormat: AnthropicTextGenerationResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat(text());
+    }
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/llamacpp/LlamaCppBakLLaVA1Format.cjs

@@ -19,9 +19,6 @@ function instruction() {
                 text += `[img-1]\n`;
             }
             text += `${instruction.instruction}\n`;
-            if (instruction.input != null) {
-                text += `${instruction.input}\n`;
-            }
             text += `ASSISTANT: `;
             return {
                 text,

package/model-provider/llamacpp/LlamaCppBakLLaVA1Format.js

@@ -16,9 +16,6 @@ export function instruction() {
                 text += `[img-1]\n`;
             }
             text += `${instruction.instruction}\n`;
-            if (instruction.input != null) {
-                text += `${instruction.input}\n`;
-            }
             text += `ASSISTANT: `;
             return {
                 text,

package/model-provider/llamacpp/LlamaCppTextGenerationModel.cjs

@@ -108,6 +108,23 @@ class LlamaCppTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             stopSequences: [],
         });
     }
+    /**
+     * Maps the prompt for a text version of the Llama.cpp prompt format (without image support).
+     */
+    withTextPromptFormat(promptFormat) {
+        return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
+            model: this.withTextPrompt().withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptFormat.stopSequences,
+                ],
+            }),
+            promptFormat,
+        });
+    }
+    /**
+     * Maps the prompt for the full Llama.cpp prompt format (incl. image support).
+     */
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -111,6 +111,13 @@ export declare class LlamaCppTextGenerationModel<CONTEXT_WINDOW_SIZE extends num
     }>;
     doStreamText(prompt: LlamaCppTextGenerationPrompt, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
     withTextPrompt(): PromptFormatTextStreamingModel<string, LlamaCppTextGenerationPrompt, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>;
+    /**
+     * Maps the prompt for a text version of the Llama.cpp prompt format (without image support).
+     */
+    withTextPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, string>): PromptFormatTextStreamingModel<INPUT_PROMPT, string, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, PromptFormatTextStreamingModel<string, LlamaCppTextGenerationPrompt, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>>;
+    /**
+     * Maps the prompt for the full Llama.cpp prompt format (incl. image support).
+     */
     withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, LlamaCppTextGenerationPrompt>): PromptFormatTextStreamingModel<INPUT_PROMPT, LlamaCppTextGenerationPrompt, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>;
     withSettings(additionalSettings: Partial<LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>>): this;
 }

package/model-provider/llamacpp/LlamaCppTextGenerationModel.js

@@ -105,6 +105,23 @@ export class LlamaCppTextGenerationModel extends AbstractModel {
             stopSequences: [],
         });
     }
+    /**
+     * Maps the prompt for a text version of the Llama.cpp prompt format (without image support).
+     */
+    withTextPromptFormat(promptFormat) {
+        return new PromptFormatTextStreamingModel({
+            model: this.withTextPrompt().withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptFormat.stopSequences,
+                ],
+            }),
+            promptFormat,
+        });
+    }
+    /**
+     * Maps the prompt for the full Llama.cpp prompt format (incl. image support).
+     */
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-provider/ollama/OllamaTextGenerationModel.cjs

@@ -7,6 +7,7 @@ const postToApi_js_1 = require("../../core/api/postToApi.cjs");
 const ZodSchema_js_1 = require("../../core/schema/ZodSchema.cjs");
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const PromptFormatTextStreamingModel_js_1 = require("../../model-function/generate-text/PromptFormatTextStreamingModel.cjs");
+const TextGenerationToolCallModel_js_1 = require("../../tool/generate-tool-call/TextGenerationToolCallModel.cjs");
 const AsyncQueue_js_1 = require("../../util/AsyncQueue.cjs");
 const parseJsonStream_js_1 = require("../../util/streaming/parseJsonStream.cjs");
 const OllamaApiConfiguration_js_1 = require("./OllamaApiConfiguration.cjs");
@@ -94,6 +95,12 @@ class OllamaTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             responseFormat: exports.OllamaTextGenerationResponseFormat.deltaIterable,
         });
     }
+    asToolCallGenerationModel(promptFormat) {
+        return new TextGenerationToolCallModel_js_1.TextGenerationToolCallModel({
+            model: this.withSettings({ format: "json" }),
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -7,6 +7,7 @@ import { Delta } from "../../model-function/Delta.js";
 import { PromptFormatTextStreamingModel } from "../../model-function/generate-text/PromptFormatTextStreamingModel.js";
 import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
 import { TextGenerationPromptFormat } from "../../model-function/generate-text/TextGenerationPromptFormat.js";
+import { TextGenerationToolCallModel, ToolCallPromptFormat } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
 /**
  * @see https://github.com/jmorganca/ollama/blob/main/docs/api.md#generate-a-completion
  */
@@ -135,6 +136,7 @@ export declare class OllamaTextGenerationModel<CONTEXT_WINDOW_SIZE extends numbe
         text: string;
     }>;
     doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
+    asToolCallGenerationModel<INPUT_PROMPT>(promptFormat: ToolCallPromptFormat<INPUT_PROMPT, string>): TextGenerationToolCallModel<INPUT_PROMPT, string, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, string>): PromptFormatTextStreamingModel<INPUT_PROMPT, string, OllamaTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>;
     withSettings(additionalSettings: Partial<OllamaTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>>): this;
 }

package/model-provider/ollama/OllamaTextGenerationModel.js

@@ -4,6 +4,7 @@ import { createJsonResponseHandler, postJsonToApi, } from "../../core/api/postTo
 import { ZodSchema } from "../../core/schema/ZodSchema.js";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { PromptFormatTextStreamingModel } from "../../model-function/generate-text/PromptFormatTextStreamingModel.js";
+import { TextGenerationToolCallModel, } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
 import { AsyncQueue } from "../../util/AsyncQueue.js";
 import { parseJsonStream } from "../../util/streaming/parseJsonStream.js";
 import { OllamaApiConfiguration } from "./OllamaApiConfiguration.js";
@@ -91,6 +92,12 @@ export class OllamaTextGenerationModel extends AbstractModel {
             responseFormat: OllamaTextGenerationResponseFormat.deltaIterable,
         });
     }
+    asToolCallGenerationModel(promptFormat) {
+        return new TextGenerationToolCallModel({
+            model: this.withSettings({ format: "json" }),
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-provider/openai/chat/OpenAIChatModel.cjs

@@ -379,6 +379,12 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             totalTokens: response.usage.total_tokens,
         };
     }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.text)());
+    }
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/openai/chat/OpenAIChatModel.d.ts

@@ -375,6 +375,10 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
         completionTokens: number;
         totalTokens: number;
     };
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt(): PromptFormatTextStreamingModel<string, OpenAIChatMessage[], OpenAIChatSettings, this>;
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/openai/chat/OpenAIChatModel.js

@@ -10,7 +10,7 @@ import { PromptFormatTextStreamingModel } from "../../../model-function/generate
 import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
-import { chat, instruction } from "./OpenAIChatPromptFormat.js";
+import { chat, instruction, text } from "./OpenAIChatPromptFormat.js";
 import { createOpenAIChatDeltaIterableQueue } from "./OpenAIChatStreamIterable.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
@@ -370,6 +370,12 @@ export class OpenAIChatModel extends AbstractModel {
             totalTokens: response.usage.total_tokens,
         };
     }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat(text());
+    }
     /**
      * Returns this model with an instruction prompt format.
      */

package/model-provider/openai/chat/OpenAIChatPromptFormat.cjs

@@ -1,8 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = void 0;
+exports.chat = exports.instruction = exports.text = void 0;
 const validateChatPrompt_js_1 = require("../../../model-function/generate-text/prompt-format/validateChatPrompt.cjs");
 const OpenAIChatMessage_js_1 = require("./OpenAIChatMessage.cjs");
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+function text() {
+    return {
+        format: (instruction) => [OpenAIChatMessage_js_1.OpenAIChatMessage.user(instruction)],
+        stopSequences: [],
+    };
+}
+exports.text = text;
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
@@ -16,9 +26,6 @@ function instruction() {
             messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.user(instruction.instruction, {
                 image: instruction.image,
             }));
-            if (instruction.input != null) {
-                messages.push(OpenAIChatMessage_js_1.OpenAIChatMessage.user(instruction.input));
-            }
             return messages;
         },
         stopSequences: [],

package/model-provider/openai/chat/OpenAIChatPromptFormat.d.ts

@@ -2,6 +2,10 @@ import { TextGenerationPromptFormat } from "../../../model-function/generate-tex
 import { ChatPrompt } from "../../../model-function/generate-text/prompt-format/ChatPrompt.js";
 import { InstructionPrompt } from "../../../model-function/generate-text/prompt-format/InstructionPrompt.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+export declare function text(): TextGenerationPromptFormat<string, Array<OpenAIChatMessage>>;
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */

package/model-provider/openai/chat/OpenAIChatPromptFormat.js

@@ -1,5 +1,14 @@
 import { validateChatPrompt } from "../../../model-function/generate-text/prompt-format/validateChatPrompt.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+export function text() {
+    return {
+        format: (instruction) => [OpenAIChatMessage.user(instruction)],
+        stopSequences: [],
+    };
+}
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
@@ -13,9 +22,6 @@ export function instruction() {
             messages.push(OpenAIChatMessage.user(instruction.instruction, {
                 image: instruction.image,
             }));
-            if (instruction.input != null) {
-                messages.push(OpenAIChatMessage.user(instruction.input));
-            }
             return messages;
         },
         stopSequences: [],

package/model-provider/openai/chat/OpenAIChatStreamIterable.cjs

@@ -6,7 +6,8 @@ const AsyncQueue_js_1 = require("../../../util/AsyncQueue.cjs");
 const parseEventSourceStream_js_1 = require("../../../util/streaming/parseEventSourceStream.cjs");
 const parseJSON_js_1 = require("../../../core/schema/parseJSON.cjs");
 const ZodSchema_js_1 = require("../../../core/schema/ZodSchema.cjs");
-const chatResponseStreamEventSchema = new ZodSchema_js_1.ZodSchema(zod_1.z.object({
+const chatCompletionChunkSchema = zod_1.z.object({
+    object: zod_1.z.literal("chat.completion.chunk"),
     id: zod_1.z.string(),
     choices: zod_1.z.array(zod_1.z.object({
         delta: zod_1.z.object({
@@ -44,8 +45,15 @@ const chatResponseStreamEventSchema = new ZodSchema_js_1.ZodSchema(zod_1.z.objec
     created: zod_1.z.number(),
     model: zod_1.z.string(),
     system_fingerprint: zod_1.z.string().optional(),
-    object: zod_1.z.literal("chat.completion.chunk"),
-}));
+});
+const chatResponseStreamEventSchema = new ZodSchema_js_1.ZodSchema(zod_1.z.union([
+    chatCompletionChunkSchema,
+    zod_1.z.object({
+        object: zod_1.z.string().refine((obj) => obj !== "chat.completion.chunk", {
+            message: "Object must not be 'chat.completion.chunk'",
+        }),
+    }),
+]));
 async function createOpenAIChatDeltaIterableQueue(stream, extractDeltaValue) {
     const queue = new AsyncQueue_js_1.AsyncQueue();
     const streamDelta = [];
@@ -68,12 +76,19 @@ async function createOpenAIChatDeltaIterableQueue(stream, extractDeltaValue) {
                         type: "error",
                         error: parseResult.error,
                     });
-                    queue.close();
-                    return;
+                    // Note: the queue is not closed on purpose. Some providers might add additional
+                    // chunks that are not parsable, and ModelFusion should be resilient to that.
+                    continue;
                 }
                 const eventData = parseResult.data;
-                for (let i = 0; i < eventData.choices.length; i++) {
-                    const eventChoice = eventData.choices[i];
+                // ignore objects that are not "chat.completion.chunk" events.
+                // Such additional objects are e.g. sent by Azure OpenAI.
+                if (eventData.object !== "chat.completion.chunk") {
+                    continue;
+                }
+                const completionChunk = eventData;
+                for (let i = 0; i < completionChunk.choices.length; i++) {
+                    const eventChoice = completionChunk.choices[i];
                     const delta = eventChoice.delta;
                     if (streamDelta[i] == null) {
                         streamDelta[i] = {

package/model-provider/openai/chat/OpenAIChatStreamIterable.js

@@ -3,7 +3,8 @@ import { AsyncQueue } from "../../../util/AsyncQueue.js";
 import { parseEventSourceStream } from "../../../util/streaming/parseEventSourceStream.js";
 import { safeParseJSON } from "../../../core/schema/parseJSON.js";
 import { ZodSchema } from "../../../core/schema/ZodSchema.js";
-const chatResponseStreamEventSchema = new ZodSchema(z.object({
+const chatCompletionChunkSchema = z.object({
+    object: z.literal("chat.completion.chunk"),
     id: z.string(),
     choices: z.array(z.object({
         delta: z.object({
@@ -41,8 +42,15 @@ const chatResponseStreamEventSchema = new ZodSchema(z.object({
     created: z.number(),
     model: z.string(),
     system_fingerprint: z.string().optional(),
-    object: z.literal("chat.completion.chunk"),
-}));
+});
+const chatResponseStreamEventSchema = new ZodSchema(z.union([
+    chatCompletionChunkSchema,
+    z.object({
+        object: z.string().refine((obj) => obj !== "chat.completion.chunk", {
+            message: "Object must not be 'chat.completion.chunk'",
+        }),
+    }),
+]));
 export async function createOpenAIChatDeltaIterableQueue(stream, extractDeltaValue) {
     const queue = new AsyncQueue();
     const streamDelta = [];
@@ -65,12 +73,19 @@ export async function createOpenAIChatDeltaIterableQueue(stream, extractDeltaVal
                         type: "error",
                         error: parseResult.error,
                     });
-                    queue.close();
-                    return;
+                    // Note: the queue is not closed on purpose. Some providers might add additional
+                    // chunks that are not parsable, and ModelFusion should be resilient to that.
+                    continue;
                 }
                 const eventData = parseResult.data;
-                for (let i = 0; i < eventData.choices.length; i++) {
-                    const eventChoice = eventData.choices[i];
+                // ignore objects that are not "chat.completion.chunk" events.
+                // Such additional objects are e.g. sent by Azure OpenAI.
+                if (eventData.object !== "chat.completion.chunk") {
+                    continue;
+                }
+                const completionChunk = eventData;
+                for (let i = 0; i < completionChunk.choices.length; i++) {
+                    const eventChoice = completionChunk.choices[i];
                     const delta = eventChoice.delta;
                     if (streamDelta[i] == null) {
                         streamDelta[i] = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building multi-modal AI applications.",
-  "version": "0.73.1",
+  "version": "0.74.1",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -69,7 +69,7 @@
     "secure-json-parse": "2.7.0",
     "ws": "8.14.2",
     "zod": "3.22.4",
-    "zod-to-json-schema": "3.21.4"
+    "zod-to-json-schema": "3.22.0"
   },
   "devDependencies": {
     "@types/node": "18.11.9",

package/tool/generate-tool-call/FunctionListToolCallPromptFormat.cjs

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instruction = exports.text = void 0;
+const nanoid_1 = require("nanoid");
+const zod_1 = require("zod");
+const ZodSchema_js_1 = require("../../core/schema/ZodSchema.cjs");
+const parseJSON_js_1 = require("../../core/schema/parseJSON.cjs");
+const functionSchema = new ZodSchema_js_1.ZodSchema(zod_1.z.object({
+    function: zod_1.z.string(),
+    parameters: zod_1.z.any(),
+}));
+const DEFAULT_FUNCTION_CALL_PROMPT = [
+    ``,
+    `Select the most suitable function and parameters ` +
+        `from the list of available functions below, based on the user's input. ` +
+        `Provide your response in JSON format.`,
+    ``,
+    `Available functions:`,
+].join("\n");
+function text({ functionCallPrompt = DEFAULT_FUNCTION_CALL_PROMPT, baseFormat, } = {}) {
+    return {
+        createPrompt(instruction, tool) {
+            const instructionWithFunctionCall = [
+                instruction,
+                functionCallPrompt,
+                `${tool.name}:`,
+                `  description: ${tool.description ?? ""}`,
+                `  parameters: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                ``,
+            ].join("\n");
+            return (baseFormat?.format(instructionWithFunctionCall) ??
+                // handled by signature overloading:
+                instructionWithFunctionCall); // eslint-disable-line @typescript-eslint/no-explicit-any
+        },
+        extractToolCall(response) {
+            const json = (0, parseJSON_js_1.parseJSON)({ text: response, schema: functionSchema });
+            return {
+                id: (0, nanoid_1.nanoid)(),
+                args: json.parameters,
+            };
+        },
+    };
+}
+exports.text = text;
+function instruction({ functionCallPrompt = DEFAULT_FUNCTION_CALL_PROMPT, baseFormat, }) {
+    return {
+        createPrompt(instruction, tool) {
+            const instructionWithFunctionCall = [
+                instruction.instruction,
+                functionCallPrompt,
+                `${tool.name}:`,
+                `  description: ${tool.description ?? ""}`,
+                `  parameters: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                ``,
+            ].join("\n");
+            return baseFormat.format({
+                ...instruction,
+                instruction: instructionWithFunctionCall,
+            });
+        },
+        extractToolCall(response) {
+            const json = (0, parseJSON_js_1.parseJSON)({ text: response, schema: functionSchema });
+            return {
+                id: (0, nanoid_1.nanoid)(),
+                args: json.parameters,
+            };
+        },
+    };
+}
+exports.instruction = instruction;

package/tool/generate-tool-call/FunctionListToolCallPromptFormat.d.ts

@@ -0,0 +1,14 @@
+import { PromptFormat } from "../../model-function/PromptFormat.js";
+import { InstructionPrompt } from "../../model-function/generate-text/prompt-format/InstructionPrompt.js";
+import { ToolCallPromptFormat } from "./TextGenerationToolCallModel.js";
+export declare function text(options?: {
+    functionCallPrompt?: string;
+}): ToolCallPromptFormat<string, string>;
+export declare function text<TARGET_PROMPT>({ functionCallPrompt, baseFormat, }: {
+    functionCallPrompt?: string;
+    baseFormat: PromptFormat<string, TARGET_PROMPT>;
+}): ToolCallPromptFormat<string, TARGET_PROMPT>;
+export declare function instruction<TARGET_PROMPT>({ functionCallPrompt, baseFormat, }: {
+    functionCallPrompt?: string;
+    baseFormat: PromptFormat<InstructionPrompt, TARGET_PROMPT>;
+}): ToolCallPromptFormat<InstructionPrompt, TARGET_PROMPT>;

package/tool/generate-tool-call/FunctionListToolCallPromptFormat.js

@@ -0,0 +1,65 @@
+import { nanoid } from "nanoid";
+import { z } from "zod";
+import { ZodSchema } from "../../core/schema/ZodSchema.js";
+import { parseJSON } from "../../core/schema/parseJSON.js";
+const functionSchema = new ZodSchema(z.object({
+    function: z.string(),
+    parameters: z.any(),
+}));
+const DEFAULT_FUNCTION_CALL_PROMPT = [
+    ``,
+    `Select the most suitable function and parameters ` +
+        `from the list of available functions below, based on the user's input. ` +
+        `Provide your response in JSON format.`,
+    ``,
+    `Available functions:`,
+].join("\n");
+export function text({ functionCallPrompt = DEFAULT_FUNCTION_CALL_PROMPT, baseFormat, } = {}) {
+    return {
+        createPrompt(instruction, tool) {
+            const instructionWithFunctionCall = [
+                instruction,
+                functionCallPrompt,
+                `${tool.name}:`,
+                `  description: ${tool.description ?? ""}`,
+                `  parameters: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                ``,
+            ].join("\n");
+            return (baseFormat?.format(instructionWithFunctionCall) ??
+                // handled by signature overloading:
+                instructionWithFunctionCall); // eslint-disable-line @typescript-eslint/no-explicit-any
+        },
+        extractToolCall(response) {
+            const json = parseJSON({ text: response, schema: functionSchema });
+            return {
+                id: nanoid(),
+                args: json.parameters,
+            };
+        },
+    };
+}
+export function instruction({ functionCallPrompt = DEFAULT_FUNCTION_CALL_PROMPT, baseFormat, }) {
+    return {
+        createPrompt(instruction, tool) {
+            const instructionWithFunctionCall = [
+                instruction.instruction,
+                functionCallPrompt,
+                `${tool.name}:`,
+                `  description: ${tool.description ?? ""}`,
+                `  parameters: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                ``,
+            ].join("\n");
+            return baseFormat.format({
+                ...instruction,
+                instruction: instructionWithFunctionCall,
+            });
+        },
+        extractToolCall(response) {
+            const json = parseJSON({ text: response, schema: functionSchema });
+            return {
+                id: nanoid(),
+                args: json.parameters,
+            };
+        },
+    };
+}

package/tool/generate-tool-call/TextGenerationToolCallModel.d.ts

@@ -2,24 +2,24 @@ import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
 import { ToolDefinition } from "../ToolDefinition.js";
 import { ToolCallGenerationModel } from "./ToolCallGenerationModel.js";
-export interface ToolCallTextPromptFormat<PROMPT> {
-    createPrompt: (prompt: PROMPT, tool: ToolDefinition<string, unknown>) => string;
+export interface ToolCallPromptFormat<SOURCE_PROMPT, TARGET_PROMPT> {
+    createPrompt: (prompt: SOURCE_PROMPT, tool: ToolDefinition<string, unknown>) => TARGET_PROMPT;
     extractToolCall: (response: string) => {
         id: string;
         args: unknown;
     } | null;
 }
-export declare class TextGenerationToolCallModel<PROMPT, MODEL extends TextGenerationModel<string, TextGenerationModelSettings>> implements ToolCallGenerationModel<PROMPT, MODEL["settings"]> {
+export declare class TextGenerationToolCallModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextGenerationModel<TARGET_PROMPT, TextGenerationModelSettings>> implements ToolCallGenerationModel<SOURCE_PROMPT, MODEL["settings"]> {
     private readonly model;
     private readonly format;
     constructor({ model, format, }: {
         model: MODEL;
-        format: ToolCallTextPromptFormat<PROMPT>;
+        format: ToolCallPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;
     });
     get modelInformation(): import("../../index.js").ModelInformation;
     get settings(): TextGenerationModelSettings;
     get settingsForEvent(): Partial<MODEL["settings"]>;
-    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: PROMPT, options?: FunctionOptions): Promise<{
+    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<{
         response: unknown;
         toolCall: {
             id: string;

package/tool/generate-tool-call/index.cjs

@@ -10,10 +10,24 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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.FunctionListToolCallPromptFormat = void 0;
+exports.FunctionListToolCallPromptFormat = __importStar(require("./FunctionListToolCallPromptFormat.cjs"));
 __exportStar(require("./TextGenerationToolCallModel.cjs"), exports);
 __exportStar(require("./ToolCallGenerationEvent.cjs"), exports);
 __exportStar(require("./ToolCallGenerationModel.cjs"), exports);

package/tool/generate-tool-call/index.d.ts

@@ -1,3 +1,4 @@
+export * as FunctionListToolCallPromptFormat from "./FunctionListToolCallPromptFormat.js";
 export * from "./TextGenerationToolCallModel.js";
 export * from "./ToolCallGenerationEvent.js";
 export * from "./ToolCallGenerationModel.js";

package/tool/generate-tool-call/index.js

@@ -1,3 +1,4 @@
+export * as FunctionListToolCallPromptFormat from "./FunctionListToolCallPromptFormat.js";
 export * from "./TextGenerationToolCallModel.js";
 export * from "./ToolCallGenerationEvent.js";
 export * from "./ToolCallGenerationModel.js";