modelfusion 0.13.0 → 0.14.0

package/README.md

@@ -43,7 +43,7 @@ You can provide API keys for the different [integrations](https://modelfusion.de
 
 Generate text using a language model and a prompt.
 You can stream the text if it is supported by the model.
-You can use [prompt mappings](https://modelfusion.dev/guide/function/generate-text/prompt-mapping) to change the prompt format of a model.
+You can use [prompt formats](https://modelfusion.dev/guide/function/generate-text/prompt-format) to change the prompt format of a model.
 
 #### generateText
 
@@ -70,16 +70,16 @@ for await (const textFragment of textStream) {
 }
 ```
 
-#### Prompt Mapping
+#### Prompt Format
 
-[Prompt mapping](https://modelfusion.dev/guide/function/generate-text/prompt-mapping) lets you use higher level prompt structures (such as instruction or chat prompts) for different models.
+[Prompt format](https://modelfusion.dev/guide/function/generate-text/prompt-format) lets you use higher level prompt structures (such as instruction or chat prompts) for different models.
 
 ```ts
 const text = await generateText(
   new LlamaCppTextGenerationModel({
     contextWindowSize: 4096, // Llama 2 context window size
     nPredict: 1000,
-  }).mapPrompt(InstructionToLlama2PromptMapping()),
+  }).withPromptFormat(Llama2InstructionPromptFormat()),
   {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
@@ -91,7 +91,7 @@ const text = await generateText(
 const textStream = await streamText(
   new OpenAIChatModel({
     model: "gpt-3.5-turbo",
-  }).mapPrompt(ChatToOpenAIChatPromptMapping()),
+  }).withPromptFormat(OpenAIChatChatPromptFormat()),
   [
     { system: "You are a celebrated poet." },
     { user: "Write a short story about a robot learning to love." },

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

@@ -1,5 +1,5 @@
-import { PromptMapping } from "../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { FunctionOptions } from "../FunctionOptions.js";
 import { Model, ModelSettings } from "../Model.js";
 import { BasicTokenizer, FullTokenizer } from "../tokenize-text/Tokenizer.js";
@@ -24,7 +24,7 @@ export interface TextGenerationModel<PROMPT, RESPONSE, FULL_DELTA, SETTINGS exte
      * Optional. Implement for streaming support.
      */
     readonly extractTextDelta: ((fullDelta: FULL_DELTA) => string | undefined) | undefined;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, PROMPT>): PromptMappingTextGenerationModel<INPUT_PROMPT, PROMPT, RESPONSE, FULL_DELTA, SETTINGS, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, RESPONSE, FULL_DELTA, SETTINGS, this>;
     /**
      * Maximum number of tokens to generate.
      */

package/model-provider/cohere/CohereTextGenerationModel.cjs

@@ -9,7 +9,7 @@ const zod_1 = require("zod");
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const AsyncQueue_js_1 = require("../../model-function/generate-text/AsyncQueue.cjs");
 const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens.cjs");
-const PromptMappingTextGenerationModel_js_1 = require("../../prompt/PromptMappingTextGenerationModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
 const CohereError_js_1 = require("./CohereError.cjs");
@@ -122,10 +122,10 @@ class CohereTextGenerationModel extends AbstractModel_js_1.AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/cohere/CohereTextGenerationModel.d.ts

@@ -3,8 +3,8 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { FunctionOptions } from "../../model-function/FunctionOptions.js";
 import { DeltaEvent } from "../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
-import { PromptMapping } from "../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { RetryFunction } from "../../util/api/RetryFunction.js";
 import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
@@ -92,7 +92,7 @@ export declare class CohereTextGenerationModel extends AbstractModel<CohereTextG
     extractText(response: CohereTextGenerationResponse): string;
     generateDeltaStreamResponse(prompt: string, options?: FunctionOptions<CohereTextGenerationModelSettings>): Promise<AsyncIterable<DeltaEvent<CohereTextGenerationDelta>>>;
     extractTextDelta(fullDelta: CohereTextGenerationDelta): string | undefined;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, string>): PromptMappingTextGenerationModel<INPUT_PROMPT, string, CohereTextGenerationResponse, CohereTextGenerationDelta, CohereTextGenerationModelSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextGenerationModel<INPUT_PROMPT, string, CohereTextGenerationResponse, CohereTextGenerationDelta, CohereTextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<CohereTextGenerationModelSettings>): this;
     get maxCompletionTokens(): number | undefined;
     withMaxCompletionTokens(maxCompletionTokens: number): this;

package/model-provider/cohere/CohereTextGenerationModel.js

@@ -3,7 +3,7 @@ import { z } from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { AsyncQueue } from "../../model-function/generate-text/AsyncQueue.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
 import { failedCohereCallResponseHandler } from "./CohereError.js";
@@ -116,10 +116,10 @@ export class CohereTextGenerationModel extends AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/huggingface/HuggingFaceTextGenerationModel.cjs

@@ -9,7 +9,7 @@ const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
 const HuggingFaceError_js_1 = require("./HuggingFaceError.cjs");
-const PromptMappingTextGenerationModel_js_1 = require("../../prompt/PromptMappingTextGenerationModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 /**
  * Create a text generation model that calls a Hugging Face Inference API Text Generation Task.
  *
@@ -103,10 +103,10 @@ class HuggingFaceTextGenerationModel extends AbstractModel_js_1.AbstractModel {
     extractText(response) {
         return response[0].generated_text;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel({
             model: this,
-            promptMapping,
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/huggingface/HuggingFaceTextGenerationModel.d.ts

@@ -4,8 +4,8 @@ import { FunctionOptions } from "../../model-function/FunctionOptions.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
 import { RetryFunction } from "../../util/api/RetryFunction.js";
 import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
-import { PromptMapping } from "../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 export interface HuggingFaceTextGenerationModelSettings extends TextGenerationModelSettings {
     model: string;
     baseUrl?: string;
@@ -58,7 +58,7 @@ export declare class HuggingFaceTextGenerationModel extends AbstractModel<Huggin
     extractText(response: HuggingFaceTextGenerationResponse): string;
     generateDeltaStreamResponse: undefined;
     extractTextDelta: undefined;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, string>): PromptMappingTextGenerationModel<INPUT_PROMPT, string, HuggingFaceTextGenerationResponse, undefined, HuggingFaceTextGenerationModelSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextGenerationModel<INPUT_PROMPT, string, HuggingFaceTextGenerationResponse, undefined, HuggingFaceTextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<HuggingFaceTextGenerationModelSettings>): this;
     get maxCompletionTokens(): number | undefined;
     withMaxCompletionTokens(maxCompletionTokens: number): this;

package/model-provider/huggingface/HuggingFaceTextGenerationModel.js

@@ -3,7 +3,7 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
 import { failedHuggingFaceCallResponseHandler } from "./HuggingFaceError.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 /**
  * Create a text generation model that calls a Hugging Face Inference API Text Generation Task.
  *
@@ -97,10 +97,10 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
     extractText(response) {
         return response[0].generated_text;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
             model: this,
-            promptMapping,
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/llamacpp/LlamaCppTextGenerationModel.cjs

@@ -9,7 +9,7 @@ const zod_1 = __importDefault(require("zod"));
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const AsyncQueue_js_1 = require("../../model-function/generate-text/AsyncQueue.cjs");
 const parseEventSourceReadableStream_js_1 = require("../../model-function/generate-text/parseEventSourceReadableStream.cjs");
-const PromptMappingTextGenerationModel_js_1 = require("../../prompt/PromptMappingTextGenerationModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
 const LlamaCppError_js_1 = require("./LlamaCppError.cjs");
@@ -76,10 +76,10 @@ class LlamaCppTextGenerationModel extends AbstractModel_js_1.AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

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

@@ -3,8 +3,8 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { FunctionOptions } from "../../model-function/FunctionOptions.js";
 import { DeltaEvent } from "../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
-import { PromptMapping } from "../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { RetryFunction } from "../../util/api/RetryFunction.js";
 import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
@@ -102,7 +102,7 @@ export declare class LlamaCppTextGenerationModel<CONTEXT_WINDOW_SIZE extends num
     extractText(response: LlamaCppTextGenerationResponse): string;
     generateDeltaStreamResponse(prompt: string, options?: FunctionOptions<LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>>): Promise<AsyncIterable<DeltaEvent<LlamaCppTextGenerationDelta>>>;
     extractTextDelta(fullDelta: LlamaCppTextGenerationDelta): string | undefined;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, string>): PromptMappingTextGenerationModel<INPUT_PROMPT, string, LlamaCppTextGenerationResponse, LlamaCppTextGenerationDelta, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextGenerationModel<INPUT_PROMPT, string, LlamaCppTextGenerationResponse, LlamaCppTextGenerationDelta, LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>, this>;
     withSettings(additionalSettings: Partial<LlamaCppTextGenerationModelSettings<CONTEXT_WINDOW_SIZE>>): this;
     get maxCompletionTokens(): number | undefined;
     withMaxCompletionTokens(maxCompletionTokens: number): this;

package/model-provider/llamacpp/LlamaCppTextGenerationModel.js

@@ -3,7 +3,7 @@ import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { AsyncQueue } from "../../model-function/generate-text/AsyncQueue.js";
 import { parseEventSourceReadableStream } from "../../model-function/generate-text/parseEventSourceReadableStream.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
 import { failedLlamaCppCallResponseHandler } from "./LlamaCppError.js";
@@ -70,10 +70,10 @@ export class LlamaCppTextGenerationModel extends AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/openai/OpenAITextGenerationModel.cjs

@@ -10,7 +10,7 @@ const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const AsyncQueue_js_1 = require("../../model-function/generate-text/AsyncQueue.cjs");
 const parseEventSourceReadableStream_js_1 = require("../../model-function/generate-text/parseEventSourceReadableStream.cjs");
 const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens.cjs");
-const PromptMappingTextGenerationModel_js_1 = require("../../prompt/PromptMappingTextGenerationModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
 const OpenAIError_js_1 = require("./OpenAIError.cjs");
@@ -156,10 +156,10 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta[0].delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/openai/OpenAITextGenerationModel.d.ts

@@ -3,8 +3,8 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { FunctionOptions } from "../../model-function/FunctionOptions.js";
 import { DeltaEvent } from "../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
-import { PromptMapping } from "../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { RetryFunction } from "../../util/api/RetryFunction.js";
 import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
@@ -134,7 +134,7 @@ export declare class OpenAITextGenerationModel extends AbstractModel<OpenAITextG
     extractText(response: OpenAITextGenerationResponse): string;
     generateDeltaStreamResponse(prompt: string, options?: FunctionOptions<OpenAITextGenerationModelSettings>): Promise<AsyncIterable<DeltaEvent<OpenAITextGenerationDelta>>>;
     extractTextDelta(fullDelta: OpenAITextGenerationDelta): string | undefined;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, string>): PromptMappingTextGenerationModel<INPUT_PROMPT, string, OpenAITextGenerationResponse, OpenAITextGenerationDelta, OpenAITextGenerationModelSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextGenerationModel<INPUT_PROMPT, string, OpenAITextGenerationResponse, OpenAITextGenerationDelta, OpenAITextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<OpenAITextGenerationModelSettings>): this;
     get maxCompletionTokens(): number | undefined;
     withMaxCompletionTokens(maxCompletionTokens: number): this;

package/model-provider/openai/OpenAITextGenerationModel.js

@@ -4,7 +4,7 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { AsyncQueue } from "../../model-function/generate-text/AsyncQueue.js";
 import { parseEventSourceReadableStream } from "../../model-function/generate-text/parseEventSourceReadableStream.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
-import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
 import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
@@ -148,10 +148,10 @@ export class OpenAITextGenerationModel extends AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta[0].delta;
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

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

@@ -7,7 +7,7 @@ exports.OpenAIChatResponseFormat = exports.OpenAIChatModel = exports.calculateOp
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const zod_1 = __importDefault(require("zod"));
 const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
-const PromptMappingTextGenerationModel_js_1 = require("../../../prompt/PromptMappingTextGenerationModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../../util/api/postToApi.cjs");
 const OpenAIError_js_1 = require("../OpenAIError.cjs");
@@ -205,10 +205,10 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
         const jsonText = response.choices[0].message.function_call.arguments;
         return secure_json_parse_1.default.parse(jsonText);
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel_js_1.PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

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

@@ -5,8 +5,8 @@ import { GenerateJsonModel } from "../../../model-function/generate-json/Generat
 import { GenerateJsonOrTextModel } from "../../../model-function/generate-json/GenerateJsonOrTextModel.js";
 import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../../model-function/generate-text/TextGenerationModel.js";
-import { PromptMapping } from "../../../prompt/PromptMapping.js";
-import { PromptMappingTextGenerationModel } from "../../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormat } from "../../../prompt/PromptFormat.js";
+import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { ResponseHandler } from "../../../util/api/postToApi.js";
 import { OpenAIModelSettings } from "../OpenAIModelSettings.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
@@ -170,7 +170,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
      */
     generateJsonResponse(prompt: OpenAIChatSingleFunctionPrompt<unknown> | OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, options?: FunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
     extractJson(response: OpenAIChatResponse): unknown;
-    mapPrompt<INPUT_PROMPT>(promptMapping: PromptMapping<INPUT_PROMPT, OpenAIChatMessage[]>): PromptMappingTextGenerationModel<INPUT_PROMPT, OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, OpenAIChatMessage[]>): PromptFormatTextGenerationModel<INPUT_PROMPT, OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
     get maxCompletionTokens(): number | undefined;
     withMaxCompletionTokens(maxCompletionTokens: number): this;

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

@@ -1,7 +1,7 @@
 import SecureJSON from "secure-json-parse";
 import z from "zod";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
-import { PromptMappingTextGenerationModel } from "../../../prompt/PromptMappingTextGenerationModel.js";
+import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../../util/api/postToApi.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
@@ -197,10 +197,10 @@ export class OpenAIChatModel extends AbstractModel {
         const jsonText = response.choices[0].message.function_call.arguments;
         return SecureJSON.parse(jsonText);
     }
-    mapPrompt(promptMapping) {
-        return new PromptMappingTextGenerationModel({
-            model: this.withStopTokens(promptMapping.stopTokens),
-            promptMapping,
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextGenerationModel({
+            model: this.withStopTokens(promptFormat.stopTokens),
+            promptFormat,
         });
     }
     withSettings(additionalSettings) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build AI applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/prompt/{AlpacaPromptMapping.cjs → AlpacaPromptFormat.cjs}

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstructionToAlpacaPromptMapping = void 0;
+exports.AlpacaInstructionPromptFormat = 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.";
 /**
- * Maps an instruction prompt to the Alpaca prompt format.
+ * Formats an instruction prompt as an Alpaca prompt.
  *
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-const InstructionToAlpacaPromptMapping = () => ({
+const AlpacaInstructionPromptFormat = () => ({
     stopTokens: [],
-    map: (instruction) => {
+    format: (instruction) => {
         let text = instruction.system ??
             (instruction.input != null
                 ? DEFAULT_SYSTEM_PROMPT_INPUT
@@ -30,4 +30,4 @@ const InstructionToAlpacaPromptMapping = () => ({
         return text;
     },
 });
-exports.InstructionToAlpacaPromptMapping = InstructionToAlpacaPromptMapping;
+exports.AlpacaInstructionPromptFormat = AlpacaInstructionPromptFormat;

package/prompt/{AlpacaPromptMapping.d.ts → AlpacaPromptFormat.d.ts}

@@ -1,11 +1,11 @@
 import { InstructionPrompt } from "./InstructionPrompt.js";
-import { PromptMapping } from "./PromptMapping.js";
+import { PromptFormat } from "./PromptFormat.js";
 /**
- * Maps an instruction prompt to the Alpaca prompt format.
+ * Formats an instruction prompt as an Alpaca prompt.
  *
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export declare const InstructionToAlpacaPromptMapping: () => PromptMapping<InstructionPrompt, string>;
+export declare const AlpacaInstructionPromptFormat: () => PromptFormat<InstructionPrompt, string>;

package/prompt/{AlpacaPromptMapping.js → AlpacaPromptFormat.js}

@@ -1,16 +1,16 @@
 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.";
 /**
- * Maps an instruction prompt to the Alpaca prompt format.
+ * Formats an instruction prompt as an Alpaca prompt.
  *
  * If the instruction has a system prompt, it overrides the default system prompt
  * (which can impact the results, because the model may be trained on the default system prompt).
  *
  * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
  */
-export const InstructionToAlpacaPromptMapping = () => ({
+export const AlpacaInstructionPromptFormat = () => ({
     stopTokens: [],
-    map: (instruction) => {
+    format: (instruction) => {
         let text = instruction.system ??
             (instruction.input != null
                 ? DEFAULT_SYSTEM_PROMPT_INPUT

package/prompt/{Llama2PromptMapping.cjs → Llama2PromptFormat.cjs}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToLlama2PromptMapping = exports.InstructionToLlama2PromptMapping = void 0;
+exports.Llama2ChatPromptFormat = exports.Llama2InstructionPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
 // see https://github.com/facebookresearch/llama/blob/6c7fe276574e78057f917549435a2554000a876d/llama/generation.py#L44
 const BEGIN_SEGMENT = "<s>";
@@ -10,19 +10,22 @@ const END_INSTRUCTION = "[/INST]\n";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
 /**
- * Maps an instruction prompt to the Llama2 prompt format.
+ * Formats an instruction prompt as a Llama 2 prompt.
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-const InstructionToLlama2PromptMapping = () => ({
+const Llama2InstructionPromptFormat = () => ({
     stopTokens: [END_SEGMENT],
-    map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
+    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`,
 });
-exports.InstructionToLlama2PromptMapping = InstructionToLlama2PromptMapping;
-const ChatToLlama2PromptMapping = () => ({
-    map: (chatPrompt) => {
+exports.Llama2InstructionPromptFormat = Llama2InstructionPromptFormat;
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+const Llama2ChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -53,4 +56,4 @@ const ChatToLlama2PromptMapping = () => ({
     },
     stopTokens: [END_SEGMENT],
 });
-exports.ChatToLlama2PromptMapping = ChatToLlama2PromptMapping;
+exports.Llama2ChatPromptFormat = Llama2ChatPromptFormat;

package/prompt/Llama2PromptFormat.d.ts

@@ -0,0 +1,13 @@
+import { PromptFormat } from "./PromptFormat.js";
+import { InstructionPrompt } from "./InstructionPrompt.js";
+import { ChatPrompt } from "./chat/ChatPrompt.js";
+/**
+ * Formats an instruction prompt as a Llama 2 prompt.
+ *
+ * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
+ */
+export declare const Llama2InstructionPromptFormat: () => PromptFormat<InstructionPrompt, string>;
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+export declare const Llama2ChatPromptFormat: () => PromptFormat<ChatPrompt, string>;

package/prompt/{Llama2PromptMapping.js → Llama2PromptFormat.js}

@@ -7,18 +7,21 @@ const END_INSTRUCTION = "[/INST]\n";
 const BEGIN_SYSTEM = "<<SYS>>\n";
 const END_SYSTEM = "\n<</SYS>>\n\n";
 /**
- * Maps an instruction prompt to the Llama2 prompt format.
+ * Formats an instruction prompt as a Llama 2 prompt.
  *
  * @see https://www.philschmid.de/llama-2#how-to-prompt-llama-2-chat
  */
-export const InstructionToLlama2PromptMapping = () => ({
+export const Llama2InstructionPromptFormat = () => ({
     stopTokens: [END_SEGMENT],
-    map: (instruction) => `${BEGIN_SEGMENT}${BEGIN_INSTRUCTION}${instruction.system != null
+    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`,
 });
-export const ChatToLlama2PromptMapping = () => ({
-    map: (chatPrompt) => {
+/**
+ * Formats a chat prompt as a Llama 2 prompt.
+ */
+export const Llama2ChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";
         for (let i = 0; i < chatPrompt.length; i++) {

package/prompt/{OpenAIChatPromptMapping.cjs → OpenAIChatPromptFormat.cjs}

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatToOpenAIChatPromptMapping = exports.InstructionToOpenAIChatPromptMapping = void 0;
+exports.OpenAIChatChatPromptFormat = exports.OpenAIChatInstructionPromptFormat = void 0;
 const validateChatPrompt_js_1 = require("./chat/validateChatPrompt.cjs");
-const InstructionToOpenAIChatPromptMapping = () => ({
-    map: (instruction) => {
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+const OpenAIChatInstructionPromptFormat = () => ({
+    format: (instruction) => {
         const messages = [];
         if (instruction.system != null) {
             messages.push({
@@ -25,9 +28,12 @@ const InstructionToOpenAIChatPromptMapping = () => ({
     },
     stopTokens: [],
 });
-exports.InstructionToOpenAIChatPromptMapping = InstructionToOpenAIChatPromptMapping;
-const ChatToOpenAIChatPromptMapping = () => ({
-    map: (chatPrompt) => {
+exports.OpenAIChatInstructionPromptFormat = OpenAIChatInstructionPromptFormat;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+const OpenAIChatChatPromptFormat = () => ({
+    format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         const messages = [];
         for (let i = 0; i < chatPrompt.length; i++) {
@@ -65,4 +71,4 @@ const ChatToOpenAIChatPromptMapping = () => ({
     },
     stopTokens: [],
 });
-exports.ChatToOpenAIChatPromptMapping = ChatToOpenAIChatPromptMapping;
+exports.OpenAIChatChatPromptFormat = OpenAIChatChatPromptFormat;