modelfusion 0.92.1 → 0.93.0

package/README.md

@@ -48,7 +48,7 @@ You can provide API keys for the different [integrations](https://modelfusion.de
 ### [Generate Text](https://modelfusion.dev/guide/function/generate-text)
 
 Generate text using a language model and a prompt. You can stream the text if it is supported by the model. You can use images for multi-modal prompting if the model supports it (e.g. with [llama.cpp](https://modelfusion.dev/guide/)).
-You can use [prompt formats](https://modelfusion.dev/guide/function/generate-text#prompt-format) to change the prompt format of a model.
+You can use [prompt templates](https://modelfusion.dev/guide/function/generate-text#prompt-format) to change the prompt template of a model.
 
 #### generateText
 
@@ -509,9 +509,9 @@ 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)
 
-### [Text Generation Prompt Formats](https://modelfusion.dev/guide/function/generate-text#prompt-format)
+### [Text Generation Prompt Templates](https://modelfusion.dev/guide/function/generate-text#prompt-format)
 
-Prompt formats let you use higher level prompt structures (such as text, instruction or chat prompts) for different models.
+Prompt templates let you use higher level prompt structures (such as text, instruction or chat prompts) for different models.
 
 #### Text Prompt Example
 
@@ -536,7 +536,7 @@ const text = await generateText(
       contextWindowSize: 4096, // Llama 2 context window size
       maxCompletionTokens: 1000,
     })
-    .withTextPromptFormat(Llama2PromptFormat.instruction()),
+    .withTextPromptTemplate(Llama2Prompt.instruction()),
   {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
@@ -575,19 +575,19 @@ const textStream = await streamText(
 );
 ```
 
-| Prompt Format | Text Prompt | Instruction Prompt | Chat Prompt |
-| ------------- | ----------- | ------------------ | ----------- |
-| OpenAI Chat   | ✅          | ✅                 | ✅          |
-| Anthropic     | ✅          | ✅                 | ✅          |
-| Llama 2       | ✅          | ✅                 | ✅          |
-| ChatML        | ✅          | ✅                 | ✅          |
-| Alpaca        | ✅          | ✅                 | ❌          |
-| Vicuna        | ❌          | ❌                 | ✅          |
-| Generic Text  | ✅          | ✅                 | ✅          |
+| Prompt Template | 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)
+### [Image Generation Prompt Templates](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:
+You an use prompt templates with image models as well, e.g. to use a basic text prompt. It is available as a shorthand method:
 
 ```ts
 const image = await generateImage(
@@ -600,10 +600,10 @@ const image = await generateImage(
 );
 ```
 
-| Prompt Format | Text Prompt |
-| ------------- | ----------- |
-| Automatic1111 | ✅          |
-| Stability     | ✅          |
+| Prompt Template | Text Prompt |
+| --------------- | ----------- |
+| Automatic1111   | ✅          |
+| Stability       | ✅          |
 
 ### Metadata and original responses
 

package/model-function/{PromptFormat.d.ts → PromptTemplate.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Prompt formats format a source prompt into the structure of a target prompt.
+ * Prompt templates format a source prompt into the structure of a target prompt.
  */
-export interface PromptFormat<SOURCE_PROMPT, TARGET_PROMPT> {
+export interface PromptTemplate<SOURCE_PROMPT, TARGET_PROMPT> {
     /**
      * Formats the source prompt into the structure of the target prompt.
      */

package/model-function/generate-image/ImageGenerationModel.d.ts

@@ -1,6 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { Model, ModelSettings } from "../Model.js";
-import { PromptFormat } from "../PromptFormat.js";
+import { PromptTemplate } from "../PromptTemplate.js";
 export interface ImageGenerationModelSettings extends ModelSettings {
 }
 export interface ImageGenerationModel<PROMPT, SETTINGS extends ImageGenerationModelSettings = ImageGenerationModelSettings> extends Model<SETTINGS> {
@@ -8,5 +8,5 @@ export interface ImageGenerationModel<PROMPT, SETTINGS extends ImageGenerationMo
         response: unknown;
         base64Image: string;
     }>;
-    withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, PROMPT>): ImageGenerationModel<INPUT_PROMPT, SETTINGS>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: PromptTemplate<INPUT_PROMPT, PROMPT>): ImageGenerationModel<INPUT_PROMPT, SETTINGS>;
 }

package/model-function/generate-image/{PromptFormatImageGenerationModel.cjs → PromptTemplateImageGenerationModel.cjs}

@@ -1,22 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptFormatImageGenerationModel = void 0;
-class PromptFormatImageGenerationModel {
-    constructor({ model, promptFormat, }) {
+exports.PromptTemplateImageGenerationModel = void 0;
+class PromptTemplateImageGenerationModel {
+    constructor({ model, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -25,20 +25,20 @@ class PromptFormatImageGenerationModel {
         return this.model.settings;
     }
     doGenerateImage(prompt, options) {
-        const mappedPrompt = this.promptFormat.format(prompt);
+        const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateImage(mappedPrompt, options);
     }
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatImageGenerationModel({ model: this, promptFormat });
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateImageGenerationModel({ model: this, promptTemplate: promptTemplate });
     }
     withSettings(additionalSettings) {
-        return new PromptFormatImageGenerationModel({
+        return new PromptTemplateImageGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
 }
-exports.PromptFormatImageGenerationModel = PromptFormatImageGenerationModel;
+exports.PromptTemplateImageGenerationModel = PromptTemplateImageGenerationModel;

package/model-function/generate-image/PromptTemplateImageGenerationModel.d.ts

@@ -0,0 +1,20 @@
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { PromptTemplate } from "../PromptTemplate.js";
+import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGenerationModel.js";
+export declare class PromptTemplateImageGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS extends ImageGenerationModelSettings, MODEL extends ImageGenerationModel<MODEL_PROMPT, SETTINGS>> implements ImageGenerationModel<PROMPT, SETTINGS> {
+    readonly model: MODEL;
+    readonly promptTemplate: PromptTemplate<PROMPT, MODEL_PROMPT>;
+    constructor({ model, promptTemplate, }: {
+        model: MODEL;
+        promptTemplate: PromptTemplate<PROMPT, MODEL_PROMPT>;
+    });
+    get modelInformation(): import("../ModelInformation.js").ModelInformation;
+    get settings(): SETTINGS;
+    doGenerateImage(prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
+        response: unknown;
+        base64Image: string;
+    }>;
+    get settingsForEvent(): Partial<SETTINGS>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: PromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateImageGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}

package/model-function/generate-image/{PromptFormatImageGenerationModel.js → PromptTemplateImageGenerationModel.js}

@@ -1,19 +1,19 @@
-export class PromptFormatImageGenerationModel {
-    constructor({ model, promptFormat, }) {
+export class PromptTemplateImageGenerationModel {
+    constructor({ model, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -22,19 +22,19 @@ export class PromptFormatImageGenerationModel {
         return this.model.settings;
     }
     doGenerateImage(prompt, options) {
-        const mappedPrompt = this.promptFormat.format(prompt);
+        const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateImage(mappedPrompt, options);
     }
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatImageGenerationModel({ model: this, promptFormat });
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateImageGenerationModel({ model: this, promptTemplate: promptTemplate });
     }
     withSettings(additionalSettings) {
-        return new PromptFormatImageGenerationModel({
+        return new PromptTemplateImageGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
 }

package/model-function/generate-structure/StructureFromTextGenerationModel.cjs

@@ -4,21 +4,21 @@ exports.StructureFromTextGenerationModel = void 0;
 const generateText_js_1 = require("../generate-text/generateText.cjs");
 const StructureParseError_js_1 = require("./StructureParseError.cjs");
 class StructureFromTextGenerationModel {
-    constructor({ model, format, }) {
+    constructor({ model, template, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "format", {
+        Object.defineProperty(this, "template", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.format = format;
+        this.template = template;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -30,14 +30,14 @@ class StructureFromTextGenerationModel {
         return this.model.settingsForEvent;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt, schema), {
+        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
             returnType: "full",
         });
         try {
             return {
                 response,
-                value: this.format.extractStructure(value),
+                value: this.template.extractStructure(value),
                 valueText: value,
             };
         }
@@ -51,7 +51,7 @@ class StructureFromTextGenerationModel {
     withSettings(additionalSettings) {
         return new StructureFromTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            format: this.format,
+            template: this.template,
         });
     }
 }

package/model-function/generate-structure/StructureFromTextGenerationModel.d.ts

@@ -2,14 +2,14 @@ import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../core/schema/Schema.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../generate-text/TextGenerationModel.js";
-import { StructureFromTextPromptFormat } from "./StructureFromTextPromptFormat.js";
+import { StructureFromTextPromptTemplate } from "./StructureFromTextPromptTemplate.js";
 import { StructureGenerationModel } from "./StructureGenerationModel.js";
 export declare class StructureFromTextGenerationModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextGenerationModel<TARGET_PROMPT, TextGenerationModelSettings>> implements StructureGenerationModel<SOURCE_PROMPT, MODEL["settings"]> {
     protected readonly model: MODEL;
-    protected readonly format: StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;
-    constructor({ model, format, }: {
+    protected readonly template: StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
+    constructor({ model, template, }: {
         model: MODEL;
-        format: StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;
+        template: StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
     });
     get modelInformation(): import("../ModelInformation.js").ModelInformation;
     get settings(): TextGenerationModelSettings;

package/model-function/generate-structure/StructureFromTextGenerationModel.js

@@ -1,21 +1,21 @@
 import { generateText } from "../generate-text/generateText.js";
 import { StructureParseError } from "./StructureParseError.js";
 export class StructureFromTextGenerationModel {
-    constructor({ model, format, }) {
+    constructor({ model, template, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "format", {
+        Object.defineProperty(this, "template", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.format = format;
+        this.template = template;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -27,14 +27,14 @@ export class StructureFromTextGenerationModel {
         return this.model.settingsForEvent;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await generateText(this.model, this.format.createPrompt(prompt, schema), {
+        const { response, value } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
             returnType: "full",
         });
         try {
             return {
                 response,
-                value: this.format.extractStructure(value),
+                value: this.template.extractStructure(value),
                 valueText: value,
             };
         }
@@ -48,7 +48,7 @@ export class StructureFromTextGenerationModel {
     withSettings(additionalSettings) {
         return new StructureFromTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            format: this.format,
+            template: this.template,
         });
     }
 }

package/model-function/generate-structure/{StructureFromTextPromptFormat.d.ts → StructureFromTextPromptTemplate.d.ts}

@@ -1,6 +1,6 @@
 import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../core/schema/Schema.js";
-export type StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT> = {
+export type StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT> = {
     createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT;
     extractStructure: (response: string) => unknown;
 };

package/model-function/generate-structure/StructureFromTextStreamingModel.cjs

@@ -12,7 +12,7 @@ class StructureFromTextStreamingModel extends StructureFromTextGenerationModel_j
         super(options);
     }
     async doStreamStructure(schema, prompt, options) {
-        const textStream = await (0, streamText_js_1.streamText)(this.model, this.format.createPrompt(prompt, schema), options);
+        const textStream = await (0, streamText_js_1.streamText)(this.model, this.template.createPrompt(prompt, schema), options);
         const queue = new AsyncQueue_js_1.AsyncQueue();
         // run async on purpose:
         (async () => {
@@ -41,14 +41,14 @@ class StructureFromTextStreamingModel extends StructureFromTextGenerationModel_j
         return queue;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt, schema), {
+        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
             returnType: "full",
         });
         try {
             return {
                 response,
-                value: this.format.extractStructure(value),
+                value: this.template.extractStructure(value),
                 valueText: value,
             };
         }
@@ -62,7 +62,7 @@ class StructureFromTextStreamingModel extends StructureFromTextGenerationModel_j
     withSettings(additionalSettings) {
         return new StructureFromTextStreamingModel({
             model: this.model.withSettings(additionalSettings),
-            format: this.format,
+            template: this.template,
         });
     }
 }

package/model-function/generate-structure/StructureFromTextStreamingModel.d.ts

@@ -5,12 +5,12 @@ import { Delta } from "../../model-function/Delta.js";
 import { AsyncQueue } from "../../util/AsyncQueue.js";
 import { TextGenerationModelSettings, TextStreamingModel } from "../generate-text/TextGenerationModel.js";
 import { StructureFromTextGenerationModel } from "./StructureFromTextGenerationModel.js";
-import { StructureFromTextPromptFormat } from "./StructureFromTextPromptFormat.js";
+import { StructureFromTextPromptTemplate } from "./StructureFromTextPromptTemplate.js";
 import { StructureStreamingModel } from "./StructureGenerationModel.js";
 export declare class StructureFromTextStreamingModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextStreamingModel<TARGET_PROMPT, TextGenerationModelSettings>> extends StructureFromTextGenerationModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL> implements StructureStreamingModel<SOURCE_PROMPT, MODEL["settings"]> {
     constructor(options: {
         model: MODEL;
-        format: StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;
+        template: StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
     });
     doStreamStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<AsyncQueue<Delta<unknown>>>;
     doGenerateStructure(schema: Schema<unknown> & JsonSchemaProducer, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<{

package/model-function/generate-structure/StructureFromTextStreamingModel.js

@@ -9,7 +9,7 @@ export class StructureFromTextStreamingModel extends StructureFromTextGeneration
         super(options);
     }
     async doStreamStructure(schema, prompt, options) {
-        const textStream = await streamText(this.model, this.format.createPrompt(prompt, schema), options);
+        const textStream = await streamText(this.model, this.template.createPrompt(prompt, schema), options);
         const queue = new AsyncQueue();
         // run async on purpose:
         (async () => {
@@ -38,14 +38,14 @@ export class StructureFromTextStreamingModel extends StructureFromTextGeneration
         return queue;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await generateText(this.model, this.format.createPrompt(prompt, schema), {
+        const { response, value } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
             returnType: "full",
         });
         try {
             return {
                 response,
-                value: this.format.extractStructure(value),
+                value: this.template.extractStructure(value),
                 valueText: value,
             };
         }
@@ -59,7 +59,7 @@ export class StructureFromTextStreamingModel extends StructureFromTextGeneration
     withSettings(additionalSettings) {
         return new StructureFromTextStreamingModel({
             model: this.model.withSettings(additionalSettings),
-            format: this.format,
+            template: this.template,
         });
     }
 }

package/model-function/generate-structure/index.cjs

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./StructureFromTextGenerationModel.cjs"), exports);
-__exportStar(require("./StructureFromTextPromptFormat.cjs"), exports);
+__exportStar(require("./StructureFromTextPromptTemplate.cjs"), exports);
 __exportStar(require("./StructureFromTextStreamingModel.cjs"), exports);
 __exportStar(require("./StructureGenerationEvent.cjs"), exports);
 __exportStar(require("./StructureGenerationModel.cjs"), exports);

package/model-function/generate-structure/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./StructureFromTextGenerationModel.js";
-export * from "./StructureFromTextPromptFormat.js";
+export * from "./StructureFromTextPromptTemplate.js";
 export * from "./StructureFromTextStreamingModel.js";
 export * from "./StructureGenerationEvent.js";
 export * from "./StructureGenerationModel.js";

package/model-function/generate-structure/index.js

@@ -1,5 +1,5 @@
 export * from "./StructureFromTextGenerationModel.js";
-export * from "./StructureFromTextPromptFormat.js";
+export * from "./StructureFromTextPromptTemplate.js";
 export * from "./StructureFromTextStreamingModel.js";
 export * from "./StructureGenerationEvent.js";
 export * from "./StructureGenerationModel.js";

package/model-function/generate-structure/jsonStructurePrompt.d.ts

@@ -1,4 +1,4 @@
 import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
 import { Schema } from "../../core/schema/Schema.js";
-import { StructureFromTextPromptFormat } from "./StructureFromTextPromptFormat.js";
-export declare function jsonStructurePrompt<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;
+import { StructureFromTextPromptTemplate } from "./StructureFromTextPromptTemplate.js";
+export declare function jsonStructurePrompt<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): StructureFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;

package/model-function/generate-text/{PromptFormatTextGenerationModel.cjs → PromptTemplateTextGenerationModel.cjs}

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptFormatTextGenerationModel = void 0;
-const StructureFromTextGenerationModel_js_1 = require("../../model-function/generate-structure/StructureFromTextGenerationModel.cjs");
+exports.PromptTemplateTextGenerationModel = void 0;
 const TextGenerationToolCallModel_js_1 = require("../../tool/generate-tool-call/TextGenerationToolCallModel.cjs");
 const TextGenerationToolCallsOrGenerateTextModel_js_1 = require("../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.cjs");
-class PromptFormatTextGenerationModel {
-    constructor({ model, promptFormat, }) {
+const StructureFromTextGenerationModel_js_1 = require("../generate-structure/StructureFromTextGenerationModel.cjs");
+class PromptTemplateTextGenerationModel {
+    constructor({ model, promptTemplate, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "promptFormat", {
+        Object.defineProperty(this, "promptTemplate", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
         this.model = model;
-        this.promptFormat = promptFormat;
+        this.promptTemplate = promptTemplate;
     }
     get modelInformation() {
         return this.model.modelInformation;
@@ -38,49 +38,49 @@ class PromptFormatTextGenerationModel {
         if (originalCountPromptTokens === undefined) {
             return undefined;
         }
-        return ((prompt) => originalCountPromptTokens(this.promptFormat.format(prompt)));
+        return ((prompt) => originalCountPromptTokens(this.promptTemplate.format(prompt)));
     }
     doGenerateText(prompt, options) {
-        const mappedPrompt = this.promptFormat.format(prompt);
+        const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateText(mappedPrompt, options);
     }
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    asToolCallGenerationModel(promptFormat) {
+    asToolCallGenerationModel(promptTemplate) {
         return new TextGenerationToolCallModel_js_1.TextGenerationToolCallModel({
             model: this,
-            format: promptFormat,
+            format: promptTemplate,
         });
     }
-    asToolCallsOrTextGenerationModel(promptFormat) {
+    asToolCallsOrTextGenerationModel(promptTemplate) {
         return new TextGenerationToolCallsOrGenerateTextModel_js_1.TextGenerationToolCallsOrGenerateTextModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
-    asStructureGenerationModel(promptFormat) {
+    asStructureGenerationModel(promptTemplate) {
         return new StructureFromTextGenerationModel_js_1.StructureFromTextGenerationModel({
             model: this,
-            format: promptFormat,
+            template: promptTemplate,
         });
     }
-    withPromptFormat(promptFormat) {
-        return new PromptFormatTextGenerationModel({
+    withPromptTemplate(promptTemplate) {
+        return new PromptTemplateTextGenerationModel({
             model: this.withSettings({
                 stopSequences: [
                     ...(this.settings.stopSequences ?? []),
-                    ...promptFormat.stopSequences,
+                    ...promptTemplate.stopSequences,
                 ],
             }),
-            promptFormat,
+            promptTemplate,
         });
     }
     withSettings(additionalSettings) {
-        return new PromptFormatTextGenerationModel({
+        return new PromptTemplateTextGenerationModel({
             model: this.model.withSettings(additionalSettings),
-            promptFormat: this.promptFormat,
+            promptTemplate: this.promptTemplate,
         });
     }
 }
-exports.PromptFormatTextGenerationModel = PromptFormatTextGenerationModel;
+exports.PromptTemplateTextGenerationModel = PromptTemplateTextGenerationModel;

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

@@ -0,0 +1,35 @@
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { TextGenerationToolCallModel, ToolCallPromptTemplate } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
+import { TextGenerationToolCallsOrGenerateTextModel, ToolCallsOrGenerateTextPromptTemplate } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
+import { StructureFromTextGenerationModel } from "../generate-structure/StructureFromTextGenerationModel.js";
+import { StructureFromTextPromptTemplate } from "../generate-structure/StructureFromTextPromptTemplate.js";
+import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerationModel.js";
+import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
+export declare class PromptTemplateTextGenerationModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<MODEL_PROMPT, SETTINGS>> implements TextGenerationModel<PROMPT, SETTINGS> {
+    readonly model: MODEL;
+    readonly promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
+    constructor({ model, promptTemplate, }: {
+        model: MODEL;
+        promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
+    });
+    get modelInformation(): import("../ModelInformation.js").ModelInformation;
+    get settings(): SETTINGS;
+    get tokenizer(): MODEL["tokenizer"];
+    get contextWindowSize(): MODEL["contextWindowSize"];
+    get countPromptTokens(): MODEL["countPromptTokens"] extends undefined ? undefined : (prompt: PROMPT) => PromiseLike<number>;
+    doGenerateText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
+        response: unknown;
+        text: string;
+        usage?: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        } | undefined;
+    }>;
+    get settingsForEvent(): Partial<SETTINGS>;
+    asToolCallGenerationModel<INPUT_PROMPT>(promptTemplate: ToolCallPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationToolCallModel<INPUT_PROMPT, PROMPT, this>;
+    asToolCallsOrTextGenerationModel<INPUT_PROMPT>(promptTemplate: ToolCallsOrGenerateTextPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationToolCallsOrGenerateTextModel<INPUT_PROMPT, PROMPT, this>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, PROMPT>): StructureFromTextGenerationModel<INPUT_PROMPT, PROMPT, this>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
+    withSettings(additionalSettings: Partial<SETTINGS>): this;
+}