modelfusion 0.45.3 → 0.46.0

package/README.md

@@ -35,7 +35,7 @@ Or use a template: [ModelFusion terminal app starter](https://github.com/lgramme
 
 You can provide API keys for the different [integrations](https://modelfusion.dev/integration/model-provider/) using environment variables (e.g., `OPENAI_API_KEY`) or pass them into the model constructors as options.
 
-### [Generate Text](https://modelfusion.dev/guide/function/generate-text)
+### [Generate and Stream 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.
@@ -71,70 +71,11 @@ for await (const textFragment of textStream) {
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Anthropic](https://modelfusion.dev/integration/model-provider/anthropic), [Cohere](https://modelfusion.dev/integration/model-provider/cohere), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp)
 
-#### Prompt Format
+### [Generate and Stream Structure](https://modelfusion.dev/guide/function/generate-structure#generatestructure)
 
-[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.
+Generate typed objects using a language model and a schema.
 
-```ts
-const text = await generateText(
-  new LlamaCppTextGenerationModel({
-    contextWindowSize: 4096, // Llama 2 context window size
-    maxCompletionTokens: 1000,
-  }).withPromptFormat(mapInstructionPromptToLlama2Format()),
-  {
-    system: "You are a story writer.",
-    instruction: "Write a short story about a robot learning to love.",
-  }
-);
-```
-
-```ts
-const textStream = await streamText(
-  new OpenAIChatModel({
-    model: "gpt-3.5-turbo",
-  }).withPromptFormat(mapChatPromptToOpenAIChatFormat()),
-  [
-    { system: "You are a celebrated poet." },
-    { user: "Write a short story about a robot learning to love." },
-    { ai: "Once upon a time, there was a robot who learned to love." },
-    { user: "That's a great start!" },
-  ]
-);
-```
-
-| Prompt Format | Instruction Prompt | Chat Prompt |
-| ------------- | ------------------ | ----------- |
-| OpenAI Chat   | ✅                 | ✅          |
-| Anthropic     | ✅                 | ✅          |
-| Llama 2       | ✅                 | ✅          |
-| Alpaca        | ✅                 | ❌          |
-| Vicuna        | ❌                 | ✅          |
-| Generic Text  | ✅                 | ✅          |
-
-#### Metadata and original responses
-
-ModelFusion model functions return rich results that include the original response and metadata when you call `.asFullResponse()` before resolving the promise.
-
-```ts
-// access the full response (needs to be typed) and the metadata:
-const { value, response, metadata } = await generateText(
-  new OpenAITextGenerationModel({
-    model: "gpt-3.5-turbo-instruct",
-    maxCompletionTokens: 1000,
-    n: 2, // generate 2 completions
-  }),
-  "Write a short story about a robot learning to love:\n\n"
-).asFullResponse();
-
-console.log(metadata);
-
-// cast to the response type:
-for (const choice of (response as OpenAITextGenerationResponse).choices) {
-  console.log(choice.text);
-}
-```
-
-### [Generate Structure](https://modelfusion.dev/guide/function/generate-structure#generatestructure)
+#### generateStructure
 
 Generate a structure that matches a schema.
 
@@ -169,7 +110,7 @@ const sentiment = await generateStructure(
 
 Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai)
 
-### [Stream Structure](https://modelfusion.dev/guide/function/generate-structure#streamstructure)
+#### streamStructure
 
 Stream a structure that matches a schema. Partial structures before the final part are untyped JSON.
 
@@ -490,6 +431,71 @@ const result = await guard(
 );
 ```
 
+### [Prompt Formats](<(https://modelfusion.dev/guide/function/generate-text/prompt-format)>)
+
+Prompt formats let you use higher level prompt structures (such as instruction or chat prompts) for different models.
+
+```ts
+const text = await generateText(
+  new LlamaCppTextGenerationModel({
+    contextWindowSize: 4096, // Llama 2 context window size
+    maxCompletionTokens: 1000,
+  }).withPromptFormat(mapInstructionPromptToLlama2Format()),
+  {
+    system: "You are a story writer.",
+    instruction: "Write a short story about a robot learning to love.",
+  }
+);
+```
+
+They can also be accessed through the shorthand methods `.withChatPrompt()` and `.withInstructionPrompt()` for many models:
+
+```ts
+const textStream = await streamText(
+  new OpenAIChatModel({
+    model: "gpt-3.5-turbo",
+  }).withChatPrompt(),
+  [
+    { system: "You are a celebrated poet." },
+    { user: "Write a short story about a robot learning to love." },
+    { ai: "Once upon a time, there was a robot who learned to love." },
+    { user: "That's a great start!" },
+  ]
+);
+```
+
+| Prompt Format | Instruction Prompt | Chat Prompt |
+| ------------- | ------------------ | ----------- |
+| OpenAI Chat   | ✅                 | ✅          |
+| Anthropic     | ✅                 | ✅          |
+| Llama 2       | ✅                 | ✅          |
+| Alpaca        | ✅                 | ❌          |
+| Vicuna        | ❌                 | ✅          |
+| Generic Text  | ✅                 | ✅          |
+
+### Metadata and original responses
+
+ModelFusion model functions return rich results that include the original response and metadata when you call `.asFullResponse()` before resolving the promise.
+
+```ts
+// access the full response (needs to be typed) and the metadata:
+const { value, response, metadata } = await generateText(
+  new OpenAITextGenerationModel({
+    model: "gpt-3.5-turbo-instruct",
+    maxCompletionTokens: 1000,
+    n: 2, // generate 2 completions
+  }),
+  "Write a short story about a robot learning to love:\n\n"
+).asFullResponse();
+
+console.log(metadata);
+
+// cast to the response type:
+for (const choice of (response as OpenAITextGenerationResponse).choices) {
+  console.log(choice.text);
+}
+```
+
 ### Observability
 
 Integrations: [Helicone](https://modelfusion.dev/integration/observability/helicone)

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

@@ -20,6 +20,13 @@ export interface TextGenerationModelSettings extends ModelSettings {
      */
     trimWhitespace?: boolean;
 }
+export interface HasContextWindowSize {
+    contextWindowSize: number;
+}
+export interface HasTokenizer<PROMPT> {
+    tokenizer: BasicTokenizer | FullTokenizer;
+    countPromptTokens(prompt: PROMPT): PromiseLike<number>;
+}
 export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends Model<SETTINGS> {
     readonly contextWindowSize: number | undefined;
     readonly tokenizer: BasicTokenizer | FullTokenizer | undefined;

package/model-provider/anthropic/AnthropicTextGenerationModel.cjs

@@ -14,6 +14,7 @@ const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const PromptFormatTextStreamingModel_js_1 = require("../../prompt/PromptFormatTextStreamingModel.cjs");
 const AnthropicApiConfiguration_js_1 = require("./AnthropicApiConfiguration.cjs");
 const AnthropicError_js_1 = require("./AnthropicError.cjs");
+const AnthropicPromptFormat_js_1 = require("./AnthropicPromptFormat.cjs");
 exports.ANTHROPIC_TEXT_GENERATION_MODELS = {
     "claude-instant-1": {
         contextWindowSize: 100000,
@@ -107,6 +108,18 @@ class AnthropicTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             responseFormat: exports.AnthropicTextGenerationResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat((0, AnthropicPromptFormat_js_1.mapInstructionPromptToAnthropicFormat)());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat((0, AnthropicPromptFormat_js_1.mapChatPromptToAnthropicFormat)());
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -55,6 +55,14 @@ export declare class AnthropicTextGenerationModel extends AbstractModel<Anthropi
         text: string;
     }>;
     doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../index.js").InstructionPrompt, string, AnthropicTextGenerationModelSettings, this>;
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(): PromptFormatTextStreamingModel<import("../../index.js").ChatPrompt, string, AnthropicTextGenerationModelSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextStreamingModel<INPUT_PROMPT, string, AnthropicTextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<AnthropicTextGenerationModelSettings>): this;
 }

package/model-provider/anthropic/AnthropicTextGenerationModel.js

@@ -8,6 +8,7 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { PromptFormatTextStreamingModel } from "../../prompt/PromptFormatTextStreamingModel.js";
 import { AnthropicApiConfiguration } from "./AnthropicApiConfiguration.js";
 import { failedAnthropicCallResponseHandler } from "./AnthropicError.js";
+import { mapChatPromptToAnthropicFormat, mapInstructionPromptToAnthropicFormat, } from "./AnthropicPromptFormat.js";
 export const ANTHROPIC_TEXT_GENERATION_MODELS = {
     "claude-instant-1": {
         contextWindowSize: 100000,
@@ -101,6 +102,18 @@ export class AnthropicTextGenerationModel extends AbstractModel {
             responseFormat: AnthropicTextGenerationResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat(mapInstructionPromptToAnthropicFormat());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat(mapChatPromptToAnthropicFormat());
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-provider/cohere/CohereTextGenerationModel.cjs

@@ -12,6 +12,7 @@ const AsyncQueue_js_1 = require("../../event-source/AsyncQueue.cjs");
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens.cjs");
 const PromptFormatTextStreamingModel_js_1 = require("../../prompt/PromptFormatTextStreamingModel.cjs");
+const TextPromptFormat_js_1 = require("../../prompt/TextPromptFormat.cjs");
 const CohereApiConfiguration_js_1 = require("./CohereApiConfiguration.cjs");
 const CohereError_js_1 = require("./CohereError.cjs");
 const CohereTokenizer_js_1 = require("./CohereTokenizer.cjs");
@@ -134,6 +135,18 @@ class CohereTextGenerationModel extends AbstractModel_js_1.AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat((0, TextPromptFormat_js_1.mapInstructionPromptToTextFormat)());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options) {
+        return this.withPromptFormat((0, TextPromptFormat_js_1.mapChatPromptToTextFormat)(options));
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -84,6 +84,17 @@ export declare class CohereTextGenerationModel extends AbstractModel<CohereTextG
     }>;
     doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
     extractTextDelta(fullDelta: CohereTextGenerationDelta): string | undefined;
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../index.js").InstructionPrompt, string, CohereTextGenerationModelSettings, this>;
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options?: {
+        user?: string;
+        ai?: string;
+    }): PromptFormatTextStreamingModel<import("../../index.js").ChatPrompt, string, CohereTextGenerationModelSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextStreamingModel<INPUT_PROMPT, string, CohereTextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<CohereTextGenerationModelSettings>): this;
 }

package/model-provider/cohere/CohereTextGenerationModel.js

@@ -6,6 +6,7 @@ import { AsyncQueue } from "../../event-source/AsyncQueue.js";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { PromptFormatTextStreamingModel } from "../../prompt/PromptFormatTextStreamingModel.js";
+import { mapChatPromptToTextFormat, mapInstructionPromptToTextFormat, } from "../../prompt/TextPromptFormat.js";
 import { CohereApiConfiguration } from "./CohereApiConfiguration.js";
 import { failedCohereCallResponseHandler } from "./CohereError.js";
 import { CohereTokenizer } from "./CohereTokenizer.js";
@@ -128,6 +129,18 @@ export class CohereTextGenerationModel extends AbstractModel {
     extractTextDelta(fullDelta) {
         return fullDelta.delta;
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat(mapInstructionPromptToTextFormat());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options) {
+        return this.withPromptFormat(mapChatPromptToTextFormat(options));
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-provider/openai/OpenAITextGenerationModel.cjs

@@ -13,6 +13,7 @@ const parseEventSourceStream_js_1 = require("../../event-source/parseEventSource
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens.cjs");
 const PromptFormatTextStreamingModel_js_1 = require("../../prompt/PromptFormatTextStreamingModel.cjs");
+const TextPromptFormat_js_1 = require("../../prompt/TextPromptFormat.cjs");
 const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("./OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
@@ -238,6 +239,18 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
             responseFormat: exports.OpenAITextResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat((0, TextPromptFormat_js_1.mapInstructionPromptToTextFormat)());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options) {
+        return this.withPromptFormat((0, TextPromptFormat_js_1.mapChatPromptToTextFormat)(options));
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -171,6 +171,17 @@ export declare class OpenAITextGenerationModel extends AbstractModel<OpenAITextG
         };
     }>;
     doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<Delta<string>>>;
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../index.js").InstructionPrompt, string, OpenAITextGenerationModelSettings, this>;
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options?: {
+        user?: string;
+        ai?: string;
+    }): PromptFormatTextStreamingModel<import("../../index.js").ChatPrompt, string, OpenAITextGenerationModelSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, string>): PromptFormatTextStreamingModel<INPUT_PROMPT, string, OpenAITextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<OpenAITextGenerationModelSettings>): this;
 }

package/model-provider/openai/OpenAITextGenerationModel.js

@@ -7,6 +7,7 @@ import { parseEventSourceStream } from "../../event-source/parseEventSourceStrea
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { PromptFormatTextStreamingModel } from "../../prompt/PromptFormatTextStreamingModel.js";
+import { mapChatPromptToTextFormat, mapInstructionPromptToTextFormat, } from "../../prompt/TextPromptFormat.js";
 import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
@@ -229,6 +230,18 @@ export class OpenAITextGenerationModel extends AbstractModel {
             responseFormat: OpenAITextResponseFormat.deltaIterable,
         });
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat(mapInstructionPromptToTextFormat());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(options) {
+        return this.withPromptFormat(mapChatPromptToTextFormat(options));
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -15,6 +15,7 @@ const PromptFormatTextStreamingModel_js_1 = require("../../../prompt/PromptForma
 const OpenAIApiConfiguration_js_1 = require("../OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("../OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
+const OpenAIChatPromptFormat_js_1 = require("./OpenAIChatPromptFormat.cjs");
 const OpenAIChatStreamIterable_js_1 = require("./OpenAIChatStreamIterable.cjs");
 const countOpenAIChatMessageTokens_js_1 = require("./countOpenAIChatMessageTokens.cjs");
 /*
@@ -341,6 +342,18 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             totalTokens: response.usage.total_tokens,
         };
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.mapInstructionPromptToOpenAIChatFormat)());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.mapChatPromptToOpenAIChatFormat)());
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
             model: this.withSettings({

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

@@ -307,6 +307,14 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
         completionTokens: number;
         totalTokens: number;
     };
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").InstructionPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").ChatPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, OpenAIChatMessage[]>): PromptFormatTextStreamingModel<INPUT_PROMPT, OpenAIChatMessage[], OpenAIChatSettings, this>;
     withSettings(additionalSettings: Partial<OpenAIChatSettings>): this;
 }

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

@@ -9,6 +9,7 @@ import { PromptFormatTextStreamingModel } from "../../../prompt/PromptFormatText
 import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
+import { mapChatPromptToOpenAIChatFormat, mapInstructionPromptToOpenAIChatFormat, } from "./OpenAIChatPromptFormat.js";
 import { createOpenAIChatDeltaIterableQueue } from "./OpenAIChatStreamIterable.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
@@ -332,6 +333,18 @@ export class OpenAIChatModel extends AbstractModel {
             totalTokens: response.usage.total_tokens,
         };
     }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat(mapInstructionPromptToOpenAIChatFormat());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat(mapChatPromptToOpenAIChatFormat());
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/package.json

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

package/prompt/TextPromptFormat.cjs

@@ -26,7 +26,7 @@ exports.mapInstructionPromptToTextFormat = mapInstructionPromptToTextFormat;
  * @param user The label of the user in the chat.
  * @param ai The name of the AI in the chat.
  */
-const mapChatPromptToTextFormat = ({ user, ai }) => ({
+const mapChatPromptToTextFormat = ({ user = "user", ai = "ai", } = {}) => ({
     format: (chatPrompt) => {
         (0, validateChatPrompt_js_1.validateChatPrompt)(chatPrompt);
         let text = "";

package/prompt/TextPromptFormat.d.ts

@@ -11,7 +11,7 @@ export declare const mapInstructionPromptToTextFormat: () => PromptFormat<Instru
  * @param user The label of the user in the chat.
  * @param ai The name of the AI in the chat.
  */
-export declare const mapChatPromptToTextFormat: ({ user, ai, }: {
-    user: string;
-    ai: string;
+export declare const mapChatPromptToTextFormat: (options?: {
+    user?: string;
+    ai?: string;
 }) => PromptFormat<ChatPrompt, string>;

package/prompt/TextPromptFormat.js

@@ -22,7 +22,7 @@ export const mapInstructionPromptToTextFormat = () => ({
  * @param user The label of the user in the chat.
  * @param ai The name of the AI in the chat.
  */
-export const mapChatPromptToTextFormat = ({ user, ai }) => ({
+export const mapChatPromptToTextFormat = ({ user = "user", ai = "ai", } = {}) => ({
     format: (chatPrompt) => {
         validateChatPrompt(chatPrompt);
         let text = "";

package/prompt/chat/trimChatPrompt.d.ts

@@ -1,4 +1,4 @@
-import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
+import { HasContextWindowSize, HasTokenizer, TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
 import { ChatPrompt } from "./ChatPrompt.js";
 /**
  * Keeps only the most recent messages in the prompt, while leaving enough space for the completion.
@@ -12,9 +12,6 @@ import { ChatPrompt } from "./ChatPrompt.js";
  */
 export declare function trimChatPrompt({ prompt, model, tokenLimit, }: {
     prompt: ChatPrompt;
-    model: TextGenerationModel<ChatPrompt, TextGenerationModelSettings> & {
-        contextWindowSize: number;
-        countPromptTokens: (prompt: ChatPrompt) => PromiseLike<number>;
-    };
+    model: TextGenerationModel<ChatPrompt, TextGenerationModelSettings> & HasTokenizer<ChatPrompt> & HasContextWindowSize;
     tokenLimit?: number;
 }): Promise<ChatPrompt>;