Add Mistral instruct prompt template.

examples/basic/src/model-provider/llamacpp/llamacpp-stream-text-with-mistral-instruction-prompt-example.ts

@@ -0,0 +1,20 @@
+import { MistralInstructPrompt, llamacpp, streamText } from "modelfusion";
+
+// example assumes you are running a mistral instruct model with llama.cpp
+async function main() {
+  const textStream = await streamText(
+    llamacpp
+      .TextGenerator({ maxGenerationTokens: 512 })
+      .withTextPromptTemplate(MistralInstructPrompt.instruction()),
+    {
+      system: "You are a celebrated poet.",
+      instruction: "Write a short story about a robot learning to love.",
+    }
+  );
+
+  for await (const textPart of textStream) {
+    process.stdout.write(textPart);
+  }
+}
+
+main().catch(console.error);

examples/basic/src/model-provider/ollama/ollama-chat-use-tools-or-generator-text-mistral-example.ts

@@ -27,9 +27,7 @@ async function main() {
     [
       new ImageGeneratorTool({
         model: automatic1111
-          .ImageGenerator({
-            model: "rpg_v5",
-          })
+          .ImageGenerator({ model: "rpg_v5" })
           .withTextPrompt(),
       }),
     ],

examples/basic/src/model-provider/ollama/ollama-completion-generate-text-example.ts

@@ -1,18 +1,19 @@
 import dotenv from "dotenv";
-import { generateText, ollama } from "modelfusion";
+import { MistralInstructPrompt, generateText, ollama } from "modelfusion";
 
 dotenv.config();
 
 async function main() {
   const text = await generateText(
     ollama
       .CompletionTextGenerator({
-        model: "mistral:text",
+        model: "mistral",
         maxGenerationTokens: 120,
+        raw: true, // use prompt template below
       })
-      .withTextPrompt(),
+      .withTextPromptTemplate(MistralInstructPrompt.text()),
 
-    "Write a short story about a robot learning to love:\n\n"
+    "Write a short story about a robot learning to love."
   );
 
   console.log(text);

examples/basic/src/model-provider/ollama/ollama-completion-stream-structure-example.ts

@@ -18,7 +18,7 @@ async function main() {
         maxGenerationTokens: 1024,
         temperature: 0,
         format: "json",
-        raw: true,
+        raw: true, // use prompt template below
         stopSequences: ["\n\n"], // prevent infinite generation
       })
       .withTextPromptTemplate(ChatMLPrompt.instruction()) // needed for jsonStructurePrompt.text()

examples/basic/src/model-provider/ollama/ollama-completion-stream-text-example.ts

@@ -1,16 +1,17 @@
 import dotenv from "dotenv";
-import { ollama, streamText } from "modelfusion";
+import { MistralInstructPrompt, ollama, streamText } from "modelfusion";
 
 dotenv.config();
 
 async function main() {
   const textStream = await streamText(
     ollama
       .CompletionTextGenerator({
-        model: "mistral:text",
+        model: "mistral",
         maxGenerationTokens: 500,
+        raw: true, // use prompt template below
       })
-      .withTextPrompt(),
+      .withTextPromptTemplate(MistralInstructPrompt.text()),
 
     "Write a short story about a robot learning to love:\n\n"
   );

examples/basic/src/model-provider/ollama/ollama-completion-stream-text-json-example.ts

@@ -1,5 +1,5 @@
 import dotenv from "dotenv";
-import { ollama, streamText } from "modelfusion";
+import { MistralInstructPrompt, ollama, streamText } from "modelfusion";
 
 dotenv.config();
 
@@ -10,8 +10,9 @@ async function main() {
         model: "mistral",
         maxGenerationTokens: 500,
         format: "json",
+        raw: true, // use prompt template below
       })
-      .withTextPrompt(),
+      .withTextPromptTemplate(MistralInstructPrompt.text()),
 
     "Generate 3 character descriptions for a fantasy role playing game. " +
       "Respond using JSON."

examples/basic/src/model-provider/ollama/ollama-completion-stream-text-raw-example.ts

@@ -1,12 +1,12 @@
 import dotenv from "dotenv";
-import { ollama, streamText } from "modelfusion";
+import { MistralInstructPrompt, ollama, streamText } from "modelfusion";
 
 dotenv.config();
 
 async function main() {
   const textStream = await streamText(
     ollama.CompletionTextGenerator({
-      model: "mistral:text",
+      model: "mistral:text", // raw mistral model without instruct fine-tuning
       maxGenerationTokens: 500,
     }),
     { prompt: "Write a short story about a robot learning to love:\n\n" }

examples/basic/src/model-provider/ollama/ollama-completion-use-tool-mistral-example.ts

@@ -1,6 +1,11 @@
 import { MathJsTool } from "@modelfusion/mathjs-tool";
 import dotenv from "dotenv";
-import { Llama2Prompt, jsonToolCallPrompt, ollama, useTool } from "modelfusion";
+import {
+  MistralInstructPrompt,
+  jsonToolCallPrompt,
+  ollama,
+  useTool,
+} from "modelfusion";
 
 dotenv.config();
 
@@ -13,9 +18,10 @@ async function main() {
         model: "mistral",
         format: "json",
         temperature: 0,
-        raw: true,
+        raw: true, // use prompt template below
+        stopSequences: ["\n\n"], // prevent infinite generation
       })
-      .withTextPromptTemplate(Llama2Prompt.instruction()) // TODO Mistral prompt template
+      .withTextPromptTemplate(MistralInstructPrompt.instruction())
       .asToolCallGenerationModel(jsonToolCallPrompt.text()),
 
     new MathJsTool({ name: "calculator" }),

examples/basic/src/model-provider/ollama/ollama-completion-use-tools-or-generate-text-mixtral-example.ts

@@ -1,6 +1,6 @@
 import dotenv from "dotenv";
 import {
-  Llama2Prompt,
+  MistralInstructPrompt,
   modelfusion,
   ollama,
   useToolsOrGenerateText,
@@ -19,9 +19,10 @@ async function main() {
       .CompletionTextGenerator({
         model: "mixtral",
         temperature: 0,
-        raw: true,
+        raw: true, // use prompt template below
+        stopSequences: ["\n\n"], // prevent infinite generation
       })
-      .withTextPromptTemplate(Llama2Prompt.instruction()) // TODO mistral
+      .withTextPromptTemplate(MistralInstructPrompt.instruction())
       .asToolCallsOrTextGenerationModel(mistralMultiToolCallPromptTemplate),
 
     [calculator, weather],

packages/modelfusion/src/model-function/generate-text/prompt-template/MistralInstructPromptTemplate.test.ts

@@ -0,0 +1,72 @@
+import { chat, instruction, text } from "./MistralInstructPromptTemplate.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();
+  });
+});