modelfusion 0.92.0 → 0.93.0

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

@@ -7,9 +7,9 @@ exports.OpenAIChatFunctionCallStructureGenerationModel = void 0;
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const StructureParseError_js_1 = require("../../../model-function/generate-structure/StructureParseError.cjs");
 const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
-const OpenAIChatPromptFormat_js_1 = require("./OpenAIChatPromptFormat.cjs");
+const OpenAIChatPromptTemplate_js_1 = require("./OpenAIChatPromptTemplate.cjs");
 class OpenAIChatFunctionCallStructureGenerationModel {
-    constructor({ model, fnName, fnDescription, promptFormat, }) {
+    constructor({ model, fnName, fnDescription, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
@@ -28,7 +28,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -37,7 +37,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
         this.model = model;
         this.fnName = fnName;
         this.fnDescription = fnDescription;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -49,29 +49,29 @@ class OpenAIChatFunctionCallStructureGenerationModel {
         return this.model.settingsForEvent;
     }
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
     withTextPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.text)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.text)());
     }
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.instruction)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.instruction)());
     }
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
     withChatPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.chat)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.chat)());
     }
-    withPromptFormat(promptFormat) {
+    withPromptTemplate(promptTemplate) {
         return new OpenAIChatFunctionCallStructureGenerationModel({
             model: this.model,
             fnName: this.fnName,
             fnDescription: this.fnDescription,
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {
@@ -79,7 +79,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
             model: this.model.withSettings(additionalSettings),
             fnName: this.fnName,
             fnDescription: this.fnDescription,
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
     /**
@@ -91,12 +91,12 @@ class OpenAIChatFunctionCallStructureGenerationModel {
      */
     async doGenerateStructure(schema, prompt, // first argument of the function
     options) {
-        const expandedPrompt = this.promptFormat.format(prompt);
+        const expandedPrompt = this.promptTemplate.format(prompt);
         const response = await this.model
             .withSettings({
             stopSequences: [
                 ...(this.settings.stopSequences ?? []),
-                ...this.promptFormat.stopSequences,
+                ...this.promptTemplate.stopSequences,
             ],
         })
             .callAPI(expandedPrompt, {
@@ -129,7 +129,7 @@ class OpenAIChatFunctionCallStructureGenerationModel {
     }
     async doStreamStructure(schema, prompt, // first argument of the function
     options) {
-        const expandedPrompt = this.promptFormat.format(prompt);
+        const expandedPrompt = this.promptTemplate.format(prompt);
         return this.model.callAPI(expandedPrompt, {
             ...options,
             responseFormat: AbstractOpenAIChatModel_js_1.OpenAIChatResponseFormat.structureDeltaIterable,

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

@@ -2,37 +2,37 @@ import { FunctionOptions } from "../../../core/FunctionOptions.js";
 import { JsonSchemaProducer } from "../../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../../core/schema/Schema.js";
 import { StructureGenerationModel } from "../../../model-function/generate-structure/StructureGenerationModel.js";
-import { TextGenerationPromptFormat } from "../../../model-function/generate-text/TextGenerationPromptFormat.js";
+import { TextGenerationPromptTemplate } from "../../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { OpenAIChatPrompt } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatModel, OpenAIChatSettings } from "./OpenAIChatModel";
-export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatPrompt>> implements StructureGenerationModel<Parameters<PROMPT_FORMAT["format"]>[0], // first argument of the function
+export declare class OpenAIChatFunctionCallStructureGenerationModel<PROMPT_TEMPLATE extends TextGenerationPromptTemplate<unknown, OpenAIChatPrompt>> implements StructureGenerationModel<Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
 OpenAIChatSettings> {
     readonly model: OpenAIChatModel;
     readonly fnName: string;
     readonly fnDescription?: string;
-    readonly promptFormat: PROMPT_FORMAT;
-    constructor({ model, fnName, fnDescription, promptFormat, }: {
+    readonly promptTemplate: PROMPT_TEMPLATE;
+    constructor({ model, fnName, fnDescription, promptTemplate, }: {
         model: OpenAIChatModel;
         fnName: string;
         fnDescription?: string;
-        promptFormat: PROMPT_FORMAT;
+        promptTemplate: PROMPT_TEMPLATE;
     });
     get modelInformation(): import("../../../index.js").ModelInformation;
     get settings(): OpenAIChatSettings;
     get settingsForEvent(): Partial<OpenAIChatSettings>;
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
-    withTextPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<string, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    withTextPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<string, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
-    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
-    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
-    withPromptFormat<TARGET_PROMPT_FORMAT extends TextGenerationPromptFormat<unknown, OpenAIChatPrompt>>(promptFormat: TARGET_PROMPT_FORMAT): OpenAIChatFunctionCallStructureGenerationModel<TARGET_PROMPT_FORMAT>;
+    withChatPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    withPromptTemplate<TARGET_PROMPT_FORMAT extends TextGenerationPromptTemplate<unknown, OpenAIChatPrompt>>(promptTemplate: TARGET_PROMPT_FORMAT): OpenAIChatFunctionCallStructureGenerationModel<TARGET_PROMPT_FORMAT>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
     /**
      * JSON generation uses the OpenAI GPT function calling API.
@@ -41,7 +41,7 @@ OpenAIChatSettings> {
      *
      * @see https://platform.openai.com/docs/guides/gpt/function-calling
      */
-    doGenerateStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: Parameters<PROMPT_FORMAT["format"]>[0], // first argument of the function
+    doGenerateStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
     options?: FunctionOptions): Promise<{
         response: {
             object: "chat.completion";
@@ -84,6 +84,6 @@ OpenAIChatSettings> {
             totalTokens: number;
         };
     }>;
-    doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: Parameters<PROMPT_FORMAT["format"]>[0], // first argument of the function
+    doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: Parameters<PROMPT_TEMPLATE["format"]>[0], // first argument of the function
     options?: FunctionOptions): Promise<AsyncIterable<import("../../../index.js").Delta<unknown>>>;
 }

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

@@ -1,9 +1,9 @@
 import SecureJSON from "secure-json-parse";
 import { StructureParseError } from "../../../model-function/generate-structure/StructureParseError.js";
 import { OpenAIChatResponseFormat, } from "./AbstractOpenAIChatModel.js";
-import { chat, instruction, text } from "./OpenAIChatPromptFormat.js";
+import { chat, instruction, text } from "./OpenAIChatPromptTemplate.js";
 export class OpenAIChatFunctionCallStructureGenerationModel {
-    constructor({ model, fnName, fnDescription, promptFormat, }) {
+    constructor({ model, fnName, fnDescription, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
@@ -22,7 +22,7 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -31,7 +31,7 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
         this.model = model;
         this.fnName = fnName;
         this.fnDescription = fnDescription;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -43,29 +43,29 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
         return this.model.settingsForEvent;
     }
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
     withTextPrompt() {
-        return this.withPromptFormat(text());
+        return this.withPromptTemplate(text());
     }
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat(instruction());
+        return this.withPromptTemplate(instruction());
     }
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
     withChatPrompt() {
-        return this.withPromptFormat(chat());
+        return this.withPromptTemplate(chat());
     }
-    withPromptFormat(promptFormat) {
+    withPromptTemplate(promptTemplate) {
         return new OpenAIChatFunctionCallStructureGenerationModel({
             model: this.model,
             fnName: this.fnName,
             fnDescription: this.fnDescription,
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {
@@ -73,7 +73,7 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
             model: this.model.withSettings(additionalSettings),
             fnName: this.fnName,
             fnDescription: this.fnDescription,
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
     /**
@@ -85,12 +85,12 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
      */
     async doGenerateStructure(schema, prompt, // first argument of the function
     options) {
-        const expandedPrompt = this.promptFormat.format(prompt);
+        const expandedPrompt = this.promptTemplate.format(prompt);
         const response = await this.model
             .withSettings({
             stopSequences: [
                 ...(this.settings.stopSequences ?? []),
-                ...this.promptFormat.stopSequences,
+                ...this.promptTemplate.stopSequences,
             ],
         })
             .callAPI(expandedPrompt, {
@@ -123,7 +123,7 @@ export class OpenAIChatFunctionCallStructureGenerationModel {
     }
     async doStreamStructure(schema, prompt, // first argument of the function
     options) {
-        const expandedPrompt = this.promptFormat.format(prompt);
+        const expandedPrompt = this.promptTemplate.format(prompt);
         return this.model.callAPI(expandedPrompt, {
             ...options,
             responseFormat: OpenAIChatResponseFormat.structureDeltaIterable,

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

@@ -1,4 +1,4 @@
-import { MultiModalInput } from "../../../model-function/generate-text/prompt-format/Content.js";
+import { MultiModalInput } from "../../../model-function/generate-text/prompt-template/Content.js";
 import { ToolCall } from "../../../tool/ToolCall.js";
 export type OpenAIChatMessage = {
     role: "system";

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

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
 const StructureFromTextStreamingModel_js_1 = require("../../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
-const PromptFormatTextStreamingModel_js_1 = require("../../../model-function/generate-text/PromptFormatTextStreamingModel.cjs");
+const PromptTemplateTextStreamingModel_js_1 = require("../../../model-function/generate-text/PromptTemplateTextStreamingModel.cjs");
 const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
 const AbstractOpenAIChatModel_js_1 = require("./AbstractOpenAIChatModel.cjs");
 const OpenAIChatFunctionCallStructureGenerationModel_js_1 = require("./OpenAIChatFunctionCallStructureGenerationModel.cjs");
-const OpenAIChatPromptFormat_js_1 = require("./OpenAIChatPromptFormat.cjs");
+const OpenAIChatPromptTemplate_js_1 = require("./OpenAIChatPromptTemplate.cjs");
 const countOpenAIChatMessageTokens_js_1 = require("./countOpenAIChatMessageTokens.cjs");
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -216,42 +216,42 @@ class OpenAIChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpenAIChatMod
             model: this,
             fnName,
             fnDescription,
-            promptFormat: (0, OpenAIChatPromptFormat_js_1.identity)(),
+            promptTemplate: (0, OpenAIChatPromptTemplate_js_1.identity)(),
         });
     }
-    asStructureGenerationModel(promptFormat) {
+    asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
     withTextPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.text)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.text)());
     }
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.instruction)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.instruction)());
     }
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
     withChatPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.chat)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.chat)());
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),
-                    ...promptFormat.stopSequences,
+                    ...promptTemplate.stopSequences,
                 ],
             }),
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {

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

@@ -1,8 +1,8 @@
-import { StructureFromTextPromptFormat } from "../../../model-function/generate-structure/StructureFromTextPromptFormat.js";
+import { StructureFromTextPromptTemplate } from "../../../model-function/generate-structure/StructureFromTextPromptTemplate.js";
 import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
-import { PromptFormatTextStreamingModel } from "../../../model-function/generate-text/PromptFormatTextStreamingModel.js";
+import { PromptTemplateTextStreamingModel } from "../../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
 import { TextGenerationModelSettings, TextStreamingModel } from "../../../model-function/generate-text/TextGenerationModel.js";
-import { TextGenerationPromptFormat } from "../../../model-function/generate-text/TextGenerationPromptFormat.js";
+import { TextGenerationPromptTemplate } from "../../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { ToolCallGenerationModel } from "../../../tool/generate-tool-call/ToolCallGenerationModel.js";
 import { ToolCallsOrTextGenerationModel } from "../../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
@@ -142,21 +142,21 @@ export declare class OpenAIChatModel extends AbstractOpenAIChatModel<OpenAIChatS
     asFunctionCallStructureGenerationModel({ fnName, fnDescription, }: {
         fnName: string;
         fnDescription?: string;
-    }): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("./OpenAIChatMessage.js").OpenAIChatMessage[], import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
-    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): StructureFromTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, this>;
+    }): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptTemplate<import("./OpenAIChatMessage.js").OpenAIChatMessage[], import("./OpenAIChatMessage.js").OpenAIChatMessage[]>>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, OpenAIChatPrompt>): StructureFromTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, this>;
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
-    withTextPrompt(): PromptFormatTextStreamingModel<string, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withTextPrompt(): PromptTemplateTextStreamingModel<string, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
-    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withInstructionPrompt(): PromptTemplateTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
-    withChatPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): PromptFormatTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withChatPrompt(): PromptTemplateTextStreamingModel<import("../../../index.js").TextChatPrompt | import("../../../index.js").MultiModalChatPrompt, OpenAIChatPrompt, OpenAIChatSettings, this>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, OpenAIChatPrompt>): PromptTemplateTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
 }
 export {};

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

@@ -1,9 +1,9 @@
 import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
-import { PromptFormatTextStreamingModel } from "../../../model-function/generate-text/PromptFormatTextStreamingModel.js";
+import { PromptTemplateTextStreamingModel } from "../../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
 import { AbstractOpenAIChatModel, } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatFunctionCallStructureGenerationModel } from "./OpenAIChatFunctionCallStructureGenerationModel.js";
-import { chat, identity, instruction, text } from "./OpenAIChatPromptFormat.js";
+import { chat, identity, instruction, text, } from "./OpenAIChatPromptTemplate.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -210,42 +210,42 @@ export class OpenAIChatModel extends AbstractOpenAIChatModel {
             model: this,
             fnName,
             fnDescription,
-            promptFormat: identity(),
+            promptTemplate: identity(),
         });
     }
-    asStructureGenerationModel(promptFormat) {
+    asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextStreamingModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
     withTextPrompt() {
-        return this.withPromptFormat(text());
+        return this.withPromptTemplate(text());
     }
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat(instruction());
+        return this.withPromptTemplate(instruction());
     }
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
     withChatPrompt() {
-        return this.withPromptFormat(chat());
+        return this.withPromptTemplate(chat());
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatTextStreamingModel({
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextStreamingModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),
-                    ...promptFormat.stopSequences,
+                    ...promptTemplate.stopSequences,
                 ],
             }),
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {

package/model-provider/openai/chat/{OpenAIChatPromptFormat.cjs → OpenAIChatPromptTemplate.cjs}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.chat = exports.instruction = exports.text = exports.identity = void 0;
-const ChatPrompt_js_1 = require("../../../model-function/generate-text/prompt-format/ChatPrompt.cjs");
+const ChatPrompt_js_1 = require("../../../model-function/generate-text/prompt-template/ChatPrompt.cjs");
 const OpenAIChatMessage_js_1 = require("./OpenAIChatMessage.cjs");
 /**
  * OpenAIMessage[] identity chat format.

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

@@ -0,0 +1,20 @@
+import { TextGenerationPromptTemplate } from "../../../model-function/generate-text/TextGenerationPromptTemplate.js";
+import { MultiModalChatPrompt, TextChatPrompt } from "../../../model-function/generate-text/prompt-template/ChatPrompt.js";
+import { MultiModalInstructionPrompt, TextInstructionPrompt } from "../../../model-function/generate-text/prompt-template/InstructionPrompt.js";
+import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
+/**
+ * OpenAIMessage[] identity chat format.
+ */
+export declare function identity(): TextGenerationPromptTemplate<Array<OpenAIChatMessage>, Array<OpenAIChatMessage>>;
+/**
+ * Formats a text prompt as an OpenAI chat prompt.
+ */
+export declare function text(): TextGenerationPromptTemplate<string, Array<OpenAIChatMessage>>;
+/**
+ * Formats an instruction prompt as an OpenAI chat prompt.
+ */
+export declare function instruction(): TextGenerationPromptTemplate<MultiModalInstructionPrompt | TextInstructionPrompt, Array<OpenAIChatMessage>>;
+/**
+ * Formats a chat prompt as an OpenAI chat prompt.
+ */
+export declare function chat(): TextGenerationPromptTemplate<MultiModalChatPrompt | TextChatPrompt, Array<OpenAIChatMessage>>;

package/model-provider/openai/chat/{OpenAIChatPromptFormat.js → OpenAIChatPromptTemplate.js}

@@ -1,4 +1,4 @@
-import { validateChatPrompt } from "../../../model-function/generate-text/prompt-format/ChatPrompt.js";
+import { validateChatPrompt } from "../../../model-function/generate-text/prompt-template/ChatPrompt.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 /**
  * OpenAIMessage[] identity chat format.

package/model-provider/openai/index.cjs

@@ -26,13 +26,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIChatPromptFormat = exports.openai = exports.OpenAIError = void 0;
+exports.OpenAIChatPrompt = exports.openai = void 0;
 __exportStar(require("./AzureOpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAICompletionModel.cjs"), exports);
 __exportStar(require("./OpenAICostCalculator.cjs"), exports);
-var OpenAIError_js_1 = require("./OpenAIError.cjs");
-Object.defineProperty(exports, "OpenAIError", { enumerable: true, get: function () { return OpenAIError_js_1.OpenAIError; } });
 exports.openai = __importStar(require("./OpenAIFacade.cjs"));
 __exportStar(require("./OpenAIImageGenerationModel.cjs"), exports);
 __exportStar(require("./OpenAISpeechModel.cjs"), exports);
@@ -42,5 +40,5 @@ __exportStar(require("./TikTokenTokenizer.cjs"), exports);
 __exportStar(require("./chat/AbstractOpenAIChatModel.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatMessage.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatModel.cjs"), exports);
-exports.OpenAIChatPromptFormat = __importStar(require("./chat/OpenAIChatPromptFormat.cjs"));
+exports.OpenAIChatPrompt = __importStar(require("./chat/OpenAIChatPromptTemplate.cjs"));
 __exportStar(require("./chat/countOpenAIChatMessageTokens.cjs"), exports);

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

@@ -2,7 +2,7 @@ export * from "./AzureOpenAIApiConfiguration.js";
 export * from "./OpenAIApiConfiguration.js";
 export * from "./OpenAICompletionModel.js";
 export * from "./OpenAICostCalculator.js";
-export { OpenAIError, OpenAIErrorData } from "./OpenAIError.js";
+export { OpenAIErrorData } from "./OpenAIError.js";
 export * as openai from "./OpenAIFacade.js";
 export * from "./OpenAIImageGenerationModel.js";
 export * from "./OpenAISpeechModel.js";
@@ -12,6 +12,6 @@ export * from "./TikTokenTokenizer.js";
 export * from "./chat/AbstractOpenAIChatModel.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";
+export * as OpenAIChatPrompt from "./chat/OpenAIChatPromptTemplate.js";
 export { OpenAIChatDelta } from "./chat/OpenAIChatStreamIterable.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/model-provider/openai/index.js

@@ -2,7 +2,6 @@ export * from "./AzureOpenAIApiConfiguration.js";
 export * from "./OpenAIApiConfiguration.js";
 export * from "./OpenAICompletionModel.js";
 export * from "./OpenAICostCalculator.js";
-export { OpenAIError } from "./OpenAIError.js";
 export * as openai from "./OpenAIFacade.js";
 export * from "./OpenAIImageGenerationModel.js";
 export * from "./OpenAISpeechModel.js";
@@ -12,5 +11,5 @@ export * from "./TikTokenTokenizer.js";
 export * from "./chat/AbstractOpenAIChatModel.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
-export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";
+export * as OpenAIChatPrompt from "./chat/OpenAIChatPromptTemplate.js";
 export * from "./chat/countOpenAIChatMessageTokens.js";

package/model-provider/openai-compatible/OpenAICompatibleChatModel.cjs

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAICompatibleChatModel = void 0;
 const StructureFromTextStreamingModel_js_1 = require("../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
-const PromptFormatTextStreamingModel_js_1 = require("../../model-function/generate-text/PromptFormatTextStreamingModel.cjs");
+const PromptTemplateTextStreamingModel_js_1 = require("../../model-function/generate-text/PromptTemplateTextStreamingModel.cjs");
 const AbstractOpenAIChatModel_js_1 = require("../openai/chat/AbstractOpenAIChatModel.cjs");
-const OpenAIChatPromptFormat_js_1 = require("../openai/chat/OpenAIChatPromptFormat.cjs");
+const OpenAIChatPromptTemplate_js_1 = require("../openai/chat/OpenAIChatPromptTemplate.cjs");
 /**
  * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
  *
@@ -58,39 +58,39 @@ class OpenAICompatibleChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpe
         ];
         return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
     }
-    asStructureGenerationModel(promptFormat) {
+    asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
     /**
-     * Returns this model with a text prompt format.
+     * Returns this model with a text prompt template.
      */
     withTextPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.text)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.text)());
     }
     /**
-     * Returns this model with an instruction prompt format.
+     * Returns this model with an instruction prompt template.
      */
     withInstructionPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.instruction)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.instruction)());
     }
     /**
-     * Returns this model with a chat prompt format.
+     * Returns this model with a chat prompt template.
      */
     withChatPrompt() {
-        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.chat)());
+        return this.withPromptTemplate((0, OpenAIChatPromptTemplate_js_1.chat)());
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),
-                    ...promptFormat.stopSequences,
+                    ...promptTemplate.stopSequences,
                 ],
             }),
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {