modelfusion 0.124.0 → 0.126.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## v0.126.0 - 2024-01-15
+
+### Changed
+
+- **breaking change**: rename `useTool` to `runTool` and `useTools` to `runTools` to avoid confusion with React hooks.
+
+## v0.125.0 - 2024-01-14
+
+### Added
+
+- Perplexity AI chat completion support. Example:
+
+  ```ts
+  import { openaicompatible, streamText } from "modelfusion";
+
+  const textStream = await streamText({
+    model: openaicompatible
+      .ChatTextGenerator({
+        api: openaicompatible.PerplexityApi(),
+        provider: "openaicompatible-perplexity",
+        model: "pplx-70b-online", // online model with access to web search
+        maxGenerationTokens: 500,
+      })
+      .withTextPrompt(),
+
+    prompt: "What is RAG in AI?",
+  });
+  ```
+
 ## v0.124.0 - 2024-01-13
 
 ### Added
@@ -1068,7 +1097,7 @@ Ollama edge case and error handling improvements.
 ### Changed
 
 - **breaking change**: `ChatPrompt` structure and terminology has changed to align more closely with OpenAI and similar chat prompts. This is also in preparation for integrating images and function calls results into chat prompts.
-- **breaking change**: Prompt formats are namespaced. Use e.g. `Llama2PromptFormat.chat()` instead of `mapChatPromptToLlama2Format()`. See [Prompt Format](https://modelfusion.dev/guide/function/generate-text#prompt-format) for documentation of the new prompt formats.
+- **breaking change**: Prompt formats are namespaced. Use e.g. `Llama2PromptFormat.chat()` instead of `mapChatPromptToLlama2Format()`. See [Prompt Format](https://modelfusion.dev/guide/function/generate-text#prompt-styles) for documentation of the new prompt formats.
 
 ## v0.69.0 - 2023-11-15
 
@@ -2022,3 +2051,7 @@ Since this change already affected all JSON generation calls and tools, I includ
 1. Recursive Character Splitter: A feature to split text into characters recursively for more detailed text analysis.
 1. Recursive Text Mapping: This enables recursive mapping of text, beneficial for tasks like summarization or extraction.
 1. Split-Map-Filter-Reduce for Text Processing: A process chain developed for sophisticated text handling, allowing operations to split, map, filter, and reduce text data.
+
+```
+
+```

package/README.md

@@ -30,7 +30,7 @@
 npm install modelfusion
 ```
 
-Or use a template:
+Or use a start template:
 
 - [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
 - [Next.js, Vercel AI SDK, Llama.cpp & ModelFusion starter](https://github.com/lgrammel/modelfusion-llamacpp-nextjs-starter)
@@ -39,14 +39,14 @@ Or use a template:
 ## Usage Examples
 
 > [!TIP]
-> The basic examples are a great way to get started and to explore in parallel with the [documentation](https://modelfusion.dev/). You can find them in the [examples/basic](https://github.com/lgrammel/modelfusion/tree/main/examples/basic) folder.
+> The basic examples are a great way to get started and to explore in parallel with the [documentation](https://modelfusion.dev/guide/function/). You can find them in the [examples/basic](https://github.com/lgrammel/modelfusion/tree/main/examples/basic) folder.
 
 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 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/integration/model-provider/llamacpp)).
-You can use [prompt templates](https://modelfusion.dev/guide/function/generate-text#prompt-template) to change the prompt template of a model.
+You can use [prompt styles](https://modelfusion.dev/guide/function/generate-text#prompt-styles) to use text, instruction, or chat prompts.
 
 #### generateText
 
@@ -372,12 +372,12 @@ Tools are functions (and associated metadata) that can be executed by an AI mode
 
 ModelFusion offers several tools out-of-the-box: [Math.js](https://modelfusion.dev/guide/tools/available-tools/mathjs), [MediaWiki Search](https://modelfusion.dev/guide/tools/available-tools/mediawiki-search), [SerpAPI](https://modelfusion.dev/guide/tools/available-tools/serpapi), [Google Custom Search](https://modelfusion.dev/guide/tools/available-tools/google-custom-search). You can also create [custom tools](https://modelfusion.dev/guide/tools).
 
-#### [useTool](https://modelfusion.dev/guide/tools/use-tool)
+#### [runTool](https://modelfusion.dev/guide/tools/run-tool)
 
-With `useTool`, you can ask a tool-compatible language model (e.g. OpenAI chat) to invoke a single tool. `useTool` first generates a tool call and then executes the tool with the arguments.
+With `runTool`, you can ask a tool-compatible language model (e.g. OpenAI chat) to invoke a single tool. `runTool` first generates a tool call and then executes the tool with the arguments.
 
 ```ts
-const { tool, toolCall, args, ok, result } = await useTool({
+const { tool, toolCall, args, ok, result } = await runTool({
   model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
   too: calculator,
   prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
@@ -390,12 +390,12 @@ console.log(`Ok:`, ok);
 console.log(`Result or Error:`, result);
 ```
 
-#### [useTools](https://modelfusion.dev/guide/tools/use-tools)
+#### [runTools](https://modelfusion.dev/guide/tools/run-tools)
 
-With `useTools`, you can ask a language model to generate several tool calls as well as text. The model will choose which tools (if any) should be called with which arguments. Both the text and the tool calls are optional. This function executes the tools.
+With `runTools`, you can ask a language model to generate several tool calls as well as text. The model will choose which tools (if any) should be called with which arguments. Both the text and the tool calls are optional. This function executes the tools.
 
 ```ts
-const { text, toolResults } = await useTools({
+const { text, toolResults } = await runTools({
   model: openai.ChatTextGenerator({ model: "gpt-3.5-turbo" }),
   tools: [calculator /* ... */],
   prompt: [openai.ChatMessage.user("What's fourteen times twelve?")],
@@ -404,7 +404,7 @@ const { text, toolResults } = await useTools({
 
 #### [Agent Loop](https://modelfusion.dev/guide/tools/agent-loop)
 
-You can use `useTools` to implement an agent loop that responds to user messages and executes tools. [Learn more](https://modelfusion.dev/guide/tools/agent-loop).
+You can use `runTools` to implement an agent loop that responds to user messages and executes tools. [Learn more](https://modelfusion.dev/guide/tools/agent-loop).
 
 ### [Vector Indices](https://modelfusion.dev/guide/vector-index)
 
@@ -442,11 +442,11 @@ 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 Templates](https://modelfusion.dev/guide/function/generate-text#prompt-format)
+### [Text Generation Prompt Styles](https://modelfusion.dev/guide/function/generate-text#prompt-styles)
 
-Prompt templates let you use higher level prompt structures (such as text, instruction or chat prompts) for different models.
+You can use different prompt styles (such as text, instruction or chat prompts) with ModelFusion text generation models. These prompt styles can be accessed through the methods `.withTextPrompt()`, `.withChatPrompt()` and `.withInstructionPrompt()`:
 
-#### Text Prompt Example
+#### Text Prompt Style
 
 ```ts
 const text = await generateText({
@@ -460,7 +460,7 @@ const text = await generateText({
 });
 ```
 
-#### Instruction Prompt Example
+#### Instruction Prompt Style
 
 ```ts
 const text = await generateText({
@@ -480,9 +480,7 @@ const text = await generateText({
 });
 ```
 
-They can also be accessed through the shorthand methods `.withTextPrompt()`, `.withChatPrompt()` and `.withInstructionPrompt()` for many models:
-
-#### Chat Prompt Example
+#### Chat Prompt Style
 
 ```ts
 const textStream = await streamText({
@@ -512,17 +510,6 @@ const textStream = await streamText({
 });
 ```
 
-| Prompt Template  | Text Prompt | Instruction Prompt | Chat Prompt |
-| ---------------- | ----------- | ------------------ | ----------- |
-| Alpaca           | ✅          | ✅                 | ❌          |
-| ChatML           | ✅          | ✅                 | ✅          |
-| Llama 2          | ✅          | ✅                 | ✅          |
-| Mistral Instruct | ✅          | ✅                 | ✅          |
-| NeuralChat       | ✅          | ✅                 | ✅          |
-| Synthia          | ✅          | ✅                 | ✅          |
-| Vicuna           | ✅          | ✅                 | ✅          |
-| Generic Text     | ✅          | ✅                 | ✅          |
-
 ### [Image Generation Prompt Templates](https://modelfusion.dev/guide/function/generate-image/prompt-format)
 
 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:
@@ -593,8 +580,8 @@ modelfusion.setLogFormat("detailed-object"); // log full events
   - [Embed Value](https://modelfusion.dev/guide/function/embed)
   - [Classify Value](https://modelfusion.dev/guide/function/classify)
 - [Tools](https://modelfusion.dev/guide/tools)
-  - [Use Tool](https://modelfusion.dev/guide/tools/use-tool)
-  - [Use Tools](https://modelfusion.dev/guide/tools/use-tools)
+  - [Use Tool](https://modelfusion.dev/guide/tools/run-tool)
+  - [Use Tools](https://modelfusion.dev/guide/tools/run-tools)
   - [Agent Loop](https://modelfusion.dev/guide/tools/agent-loop)
   - [Available Tools](https://modelfusion.dev/guide/tools/available-tools/)
   - [Custom Tools](https://modelfusion.dev/guide/tools/custom-tools)

package/core/FunctionEvent.d.ts

@@ -1,8 +1,8 @@
 import { ModelCallFinishedEvent, ModelCallStartedEvent } from "../model-function/ModelCallEvent.js";
 import { RetrieveFinishedEvent, RetrieveStartedEvent } from "../retriever/RetrieveEvent.js";
 import { ExecuteToolFinishedEvent, ExecuteToolStartedEvent } from "../tool/execute-tool/ExecuteToolEvent.js";
-import { UseToolFinishedEvent, UseToolStartedEvent } from "../tool/use-tool/UseToolEvent.js";
-import { useToolsFinishedEvent, useToolsStartedEvent } from "../tool/use-tools/UseToolsEvent.js";
+import { runToolFinishedEvent, runToolStartedEvent } from "../tool/run-tool/RunToolEvent.js";
+import { runToolsFinishedEvent, runToolsStartedEvent } from "../tool/run-tools/RunToolsEvent.js";
 import { UpsertIntoVectorIndexFinishedEvent, UpsertIntoVectorIndexStartedEvent } from "../vector-index/UpsertIntoVectorIndexEvent.js";
 import { ExecuteFunctionFinishedEvent, ExecuteFunctionStartedEvent } from "./ExecuteFunctionEvent.js";
 import { ExtensionFunctionFinishedEvent, ExtensionFunctionStartedEvent } from "./ExtensionFunctionEvent.js";
@@ -82,4 +82,4 @@ export interface BaseFunctionFinishedEvent extends BaseFunctionEvent {
      */
     result: BaseFunctionFinishedEventResult;
 }
-export type FunctionEvent = ExecuteFunctionStartedEvent | ExecuteFunctionFinishedEvent | ExecuteToolStartedEvent | ExecuteToolFinishedEvent | ExtensionFunctionStartedEvent | ExtensionFunctionFinishedEvent | ModelCallStartedEvent | ModelCallFinishedEvent | RetrieveStartedEvent | RetrieveFinishedEvent | UpsertIntoVectorIndexStartedEvent | UpsertIntoVectorIndexFinishedEvent | UseToolStartedEvent | UseToolFinishedEvent | useToolsStartedEvent | useToolsFinishedEvent;
+export type FunctionEvent = ExecuteFunctionStartedEvent | ExecuteFunctionFinishedEvent | ExecuteToolStartedEvent | ExecuteToolFinishedEvent | ExtensionFunctionStartedEvent | ExtensionFunctionFinishedEvent | ModelCallStartedEvent | ModelCallFinishedEvent | RetrieveStartedEvent | RetrieveFinishedEvent | UpsertIntoVectorIndexStartedEvent | UpsertIntoVectorIndexFinishedEvent | runToolStartedEvent | runToolFinishedEvent | runToolsStartedEvent | runToolsFinishedEvent;

package/model-function/generate-text/PromptTemplateFullTextModel.cjs

@@ -14,17 +14,6 @@ class PromptTemplateFullTextModel extends PromptTemplateTextStreamingModel_js_1.
         const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateToolCalls(tools, mappedPrompt, options);
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateFullTextModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateFullTextModel({
             model: this.model.withSettings(additionalSettings),

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

@@ -36,6 +36,5 @@ export declare class PromptTemplateFullTextModel<PROMPT, MODEL_PROMPT, SETTINGS
             totalTokens: number;
         } | undefined;
     }>;
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateFullTextModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/PromptTemplateFullTextModel.js

@@ -11,17 +11,6 @@ export class PromptTemplateFullTextModel extends PromptTemplateTextStreamingMode
         const mappedPrompt = this.promptTemplate.format(prompt);
         return this.model.doGenerateToolCalls(tools, mappedPrompt, options);
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateFullTextModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateFullTextModel({
             model: this.model.withSettings(additionalSettings),

package/model-function/generate-text/PromptTemplateTextGenerationModel.cjs

@@ -74,17 +74,6 @@ class PromptTemplateTextGenerationModel {
             promptTemplate: this.promptTemplate,
         });
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextGenerationModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateTextGenerationModel({
             model: this.model.withSettings(additionalSettings),

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

@@ -43,6 +43,5 @@ export declare class PromptTemplateTextGenerationModel<PROMPT, MODEL_PROMPT, SET
     asToolCallsOrTextGenerationModel<INPUT_PROMPT>(promptTemplate: ToolCallsPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationToolCallsModel<INPUT_PROMPT, PROMPT, this>;
     asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, PROMPT>): StructureFromTextGenerationModel<INPUT_PROMPT, PROMPT, this>;
     withJsonOutput(schema: Schema<unknown> & JsonSchemaProducer): this;
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/PromptTemplateTextGenerationModel.js

@@ -71,17 +71,6 @@ export class PromptTemplateTextGenerationModel {
             promptTemplate: this.promptTemplate,
         });
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextGenerationModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateTextGenerationModel({
             model: this.model.withSettings(additionalSettings),

package/model-function/generate-text/PromptTemplateTextStreamingModel.cjs

@@ -26,17 +26,6 @@ class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerationModel
             promptTemplate: this.promptTemplate,
         });
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextStreamingModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateTextStreamingModel({
             model: this.model.withSettings(additionalSettings),

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

@@ -15,6 +15,5 @@ export declare class PromptTemplateTextStreamingModel<PROMPT, MODEL_PROMPT, SETT
     extractTextDelta(delta: unknown): string | undefined;
     asStructureGenerationModel<INPUT_PROMPT>(promptTemplate: StructureFromTextPromptTemplate<INPUT_PROMPT, PROMPT>): StructureFromTextStreamingModel<INPUT_PROMPT, PROMPT, this>;
     withJsonOutput(schema: Schema<unknown> & JsonSchemaProducer): this;
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): PromptTemplateTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/PromptTemplateTextStreamingModel.js

@@ -23,17 +23,6 @@ export class PromptTemplateTextStreamingModel extends PromptTemplateTextGenerati
             promptTemplate: this.promptTemplate,
         });
     }
-    withPromptTemplate(promptTemplate) {
-        return new PromptTemplateTextStreamingModel({
-            model: this.withSettings({
-                stopSequences: [
-                    ...(this.settings.stopSequences ?? []),
-                    ...promptTemplate.stopSequences,
-                ],
-            }),
-            promptTemplate,
-        });
-    }
     withSettings(additionalSettings) {
         return new PromptTemplateTextStreamingModel({
             model: this.model.withSettings(additionalSettings),

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

@@ -6,6 +6,8 @@ import { Model, ModelSettings } from "../Model.js";
 import { BasicTokenizer, FullTokenizer } from "../tokenize-text/Tokenizer.js";
 import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
 import { TextGenerationResult } from "./TextGenerationResult.js";
+import { ChatPrompt } from "./prompt-template/ChatPrompt.js";
+import { InstructionPrompt } from "./prompt-template/InstructionPrompt.js";
 export declare const textGenerationModelProperties: readonly ["maxGenerationTokens", "stopSequences", "numberOfGenerations", "trimWhitespace"];
 export interface TextGenerationModelSettings extends ModelSettings {
     /**
@@ -82,15 +84,43 @@ export interface TextGenerationModel<PROMPT, SETTINGS extends TextGenerationMode
             totalTokens: number;
         };
     };
-    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
     /**
      * When possible, limit the output generation to the specified JSON schema,
      * or super sets of it (e.g. JSON in general).
      */
     withJsonOutput(schema: Schema<unknown> & JsonSchemaProducer): this;
 }
+export interface TextGenerationBaseModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends TextGenerationModel<PROMPT, SETTINGS> {
+    /**
+     * Returns this model with a text prompt template.
+     */
+    withTextPrompt(): TextGenerationModel<string, SETTINGS>;
+    /**
+     * Returns this model with an instruction prompt template.
+     */
+    withInstructionPrompt(): TextGenerationModel<InstructionPrompt, SETTINGS>;
+    /**
+     * Returns this model with a chat prompt template.
+     */
+    withChatPrompt(): TextGenerationModel<ChatPrompt, SETTINGS>;
+    withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextGenerationModel<INPUT_PROMPT, SETTINGS>;
+}
 export interface TextStreamingModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends TextGenerationModel<PROMPT, SETTINGS> {
     doStreamText(prompt: PROMPT, options?: FunctionCallOptions): PromiseLike<AsyncIterable<Delta<unknown>>>;
     extractTextDelta(delta: unknown): string | undefined;
+}
+export interface TextStreamingBaseModel<PROMPT, SETTINGS extends TextGenerationModelSettings = TextGenerationModelSettings> extends TextStreamingModel<PROMPT, SETTINGS> {
+    /**
+     * Returns this model with a text prompt template.
+     */
+    withTextPrompt(): TextStreamingModel<string, SETTINGS>;
+    /**
+     * Returns this model with an instruction prompt template.
+     */
+    withInstructionPrompt(): TextStreamingModel<InstructionPrompt, SETTINGS>;
+    /**
+     * Returns this model with a chat prompt template.
+     */
+    withChatPrompt(): TextStreamingModel<ChatPrompt, SETTINGS>;
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, PROMPT>): TextStreamingModel<INPUT_PROMPT, SETTINGS>;
 }

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

@@ -75,8 +75,8 @@ export declare class CohereTextEmbeddingModel extends AbstractModel<CohereTextEm
     doEmbedValues(texts: string[], options: FunctionCallOptions): Promise<{
         rawResponse: {
             embeddings: number[][];
-            texts: string[];
             id: string;
+            texts: string[];
             meta: {
                 api_version: {
                     version: string;
@@ -110,8 +110,8 @@ declare const cohereTextEmbeddingResponseSchema: z.ZodObject<{
     }>;
 }, "strip", z.ZodTypeAny, {
     embeddings: number[][];
-    texts: string[];
     id: string;
+    texts: string[];
     meta: {
         api_version: {
             version: string;
@@ -119,8 +119,8 @@ declare const cohereTextEmbeddingResponseSchema: z.ZodObject<{
     };
 }, {
     embeddings: number[][];
-    texts: string[];
     id: string;
+    texts: string[];
     meta: {
         api_version: {
             version: string;

package/model-provider/cohere/CohereTextGenerationModel.cjs

@@ -170,21 +170,18 @@ class CohereTextGenerationModel extends AbstractModel_js_1.AbstractModel {
         const chunk = delta;
         return chunk.is_finished === true ? "" : chunk.text;
     }
-    /**
-     * Returns this model with an instruction prompt template.
-     */
+    withJsonOutput() {
+        return this;
+    }
+    withTextPrompt() {
+        return this.withPromptTemplate((0, TextPromptTemplate_js_1.text)());
+    }
     withInstructionPrompt() {
         return this.withPromptTemplate((0, TextPromptTemplate_js_1.instruction)());
     }
-    /**
-     * Returns this model with a chat prompt template.
-     */
     withChatPrompt(options) {
         return this.withPromptTemplate((0, TextPromptTemplate_js_1.chat)(options));
     }
-    withJsonOutput() {
-        return this;
-    }
     withPromptTemplate(promptTemplate) {
         return new PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel({
             model: this.withSettings({

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

@@ -4,7 +4,7 @@ import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
 import { ResponseHandler } from "../../core/api/postToApi.js";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationModelSettings, TextStreamingBaseModel } from "../../model-function/generate-text/TextGenerationModel.js";
 import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { TextGenerationFinishReason } from "../../model-function/generate-text/TextGenerationResult.js";
 import { CohereTokenizer } from "./CohereTokenizer.js";
@@ -47,7 +47,7 @@ export interface CohereTextGenerationModelSettings extends TextGenerationModelSe
  *   "Write a short story about a robot learning to love:\n\n"
  * );
  */
-export declare class CohereTextGenerationModel extends AbstractModel<CohereTextGenerationModelSettings> implements TextStreamingModel<string, CohereTextGenerationModelSettings> {
+export declare class CohereTextGenerationModel extends AbstractModel<CohereTextGenerationModelSettings> implements TextStreamingBaseModel<string, CohereTextGenerationModelSettings> {
     constructor(settings: CohereTextGenerationModelSettings);
     readonly provider: "cohere";
     get modelName(): "command" | "command-light";
@@ -141,18 +141,13 @@ export declare class CohereTextGenerationModel extends AbstractModel<CohereTextG
         is_finished: true;
     }>>>;
     extractTextDelta(delta: unknown): string;
-    /**
-     * Returns this model with an instruction prompt template.
-     */
+    withJsonOutput(): this;
+    withTextPrompt(): PromptTemplateTextStreamingModel<string, string, CohereTextGenerationModelSettings, this>;
     withInstructionPrompt(): PromptTemplateTextStreamingModel<import("../../index.js").InstructionPrompt, string, CohereTextGenerationModelSettings, this>;
-    /**
-     * Returns this model with a chat prompt template.
-     */
     withChatPrompt(options?: {
         user?: string;
         assistant?: string;
     }): PromptTemplateTextStreamingModel<import("../../index.js").ChatPrompt, string, CohereTextGenerationModelSettings, this>;
-    withJsonOutput(): this;
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, string>): PromptTemplateTextStreamingModel<INPUT_PROMPT, string, CohereTextGenerationModelSettings, this>;
     withSettings(additionalSettings: Partial<CohereTextGenerationModelSettings>): this;
 }

package/model-provider/cohere/CohereTextGenerationModel.js

@@ -6,7 +6,7 @@ import { validateTypes } from "../../core/schema/validateTypes.js";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
 import { textGenerationModelProperties, } from "../../model-function/generate-text/TextGenerationModel.js";
-import { chat, instruction, } from "../../model-function/generate-text/prompt-template/TextPromptTemplate.js";
+import { chat, instruction, text, } from "../../model-function/generate-text/prompt-template/TextPromptTemplate.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { createJsonStreamResponseHandler } from "../../util/streaming/createJsonStreamResponseHandler.js";
 import { CohereApiConfiguration } from "./CohereApiConfiguration.js";
@@ -167,21 +167,18 @@ export class CohereTextGenerationModel extends AbstractModel {
         const chunk = delta;
         return chunk.is_finished === true ? "" : chunk.text;
     }
-    /**
-     * Returns this model with an instruction prompt template.
-     */
+    withJsonOutput() {
+        return this;
+    }
+    withTextPrompt() {
+        return this.withPromptTemplate(text());
+    }
     withInstructionPrompt() {
         return this.withPromptTemplate(instruction());
     }
-    /**
-     * Returns this model with a chat prompt template.
-     */
     withChatPrompt(options) {
         return this.withPromptTemplate(chat(options));
     }
-    withJsonOutput() {
-        return this;
-    }
     withPromptTemplate(promptTemplate) {
         return new PromptTemplateTextStreamingModel({
             model: this.withSettings({

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

@@ -93,21 +93,21 @@ declare const cohereTokenizationResponseSchema: z.ZodObject<{
         };
     }>;
 }, "strip", z.ZodTypeAny, {
+    tokens: number[];
+    token_strings: string[];
     meta: {
         api_version: {
             version: string;
         };
     };
+}, {
     tokens: number[];
     token_strings: string[];
-}, {
     meta: {
         api_version: {
             version: string;
         };
     };
-    tokens: number[];
-    token_strings: string[];
 }>;
 export type CohereTokenizationResponse = z.infer<typeof cohereTokenizationResponseSchema>;
 export {};

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

@@ -9,7 +9,7 @@ import { Delta } from "../../model-function/Delta.js";
 import { FlexibleStructureFromTextPromptTemplate, StructureFromTextPromptTemplate } from "../../model-function/generate-structure/StructureFromTextPromptTemplate.js";
 import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
 import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationModelSettings, TextStreamingBaseModel, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
 import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { ChatPrompt } from "../../model-function/generate-text/prompt-template/ChatPrompt.js";
 import { InstructionPrompt } from "../../model-function/generate-text/prompt-template/InstructionPrompt.js";
@@ -143,7 +143,7 @@ export interface LlamaCppCompletionPrompt {
      */
     images?: Record<number, string>;
 }
-export declare class LlamaCppCompletionModel<CONTEXT_WINDOW_SIZE extends number | undefined> extends AbstractModel<LlamaCppCompletionModelSettings<CONTEXT_WINDOW_SIZE>> implements TextStreamingModel<LlamaCppCompletionPrompt, LlamaCppCompletionModelSettings<CONTEXT_WINDOW_SIZE>> {
+export declare class LlamaCppCompletionModel<CONTEXT_WINDOW_SIZE extends number | undefined> extends AbstractModel<LlamaCppCompletionModelSettings<CONTEXT_WINDOW_SIZE>> implements TextStreamingBaseModel<LlamaCppCompletionPrompt, LlamaCppCompletionModelSettings<CONTEXT_WINDOW_SIZE>> {
     constructor(settings?: LlamaCppCompletionModelSettings<CONTEXT_WINDOW_SIZE>);
     readonly provider = "llamacpp";
     get modelName(): null;

package/model-provider/mistral/MistralChatModel.cjs

@@ -126,21 +126,12 @@ class MistralChatModel extends AbstractModel_js_1.AbstractModel {
         const chunk = delta;
         return chunk.choices[0].delta.content ?? undefined;
     }
-    /**
-     * Returns this model with a text prompt template.
-     */
     withTextPrompt() {
         return this.withPromptTemplate((0, MistralChatPromptTemplate_js_1.text)());
     }
-    /**
-     * Returns this model with an instruction prompt template.
-     */
     withInstructionPrompt() {
         return this.withPromptTemplate((0, MistralChatPromptTemplate_js_1.instruction)());
     }
-    /**
-     * Returns this model with a chat prompt template.
-     */
     withChatPrompt() {
         return this.withPromptTemplate((0, MistralChatPromptTemplate_js_1.chat)());
     }

package/model-provider/mistral/MistralChatModel.d.ts

@@ -4,7 +4,7 @@ import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
 import { ResponseHandler } from "../../core/api/postToApi.js";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { PromptTemplateTextStreamingModel } from "../../model-function/generate-text/PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationModelSettings, TextStreamingBaseModel } from "../../model-function/generate-text/TextGenerationModel.js";
 import { TextGenerationPromptTemplate } from "../../model-function/generate-text/TextGenerationPromptTemplate.js";
 import { TextGenerationFinishReason } from "../../model-function/generate-text/TextGenerationResult.js";
 export type MistralChatMessage = {
@@ -47,7 +47,7 @@ export interface MistralChatModelSettings extends TextGenerationModelSettings {
      */
     randomSeed?: number | null;
 }
-export declare class MistralChatModel extends AbstractModel<MistralChatModelSettings> implements TextStreamingModel<MistralChatPrompt, MistralChatModelSettings> {
+export declare class MistralChatModel extends AbstractModel<MistralChatModelSettings> implements TextStreamingBaseModel<MistralChatPrompt, MistralChatModelSettings> {
     constructor(settings: MistralChatModelSettings);
     readonly provider = "mistral";
     get modelName(): "mistral-tiny" | "mistral-small" | "mistral-medium";
@@ -149,17 +149,8 @@ export declare class MistralChatModel extends AbstractModel<MistralChatModelSett
         created?: number | undefined;
     }>>>;
     extractTextDelta(delta: unknown): string | undefined;
-    /**
-     * Returns this model with a text prompt template.
-     */
     withTextPrompt(): PromptTemplateTextStreamingModel<string, MistralChatPrompt, MistralChatModelSettings, this>;
-    /**
-     * Returns this model with an instruction prompt template.
-     */
     withInstructionPrompt(): PromptTemplateTextStreamingModel<import("../../index.js").InstructionPrompt, MistralChatPrompt, MistralChatModelSettings, this>;
-    /**
-     * Returns this model with a chat prompt template.
-     */
     withChatPrompt(): PromptTemplateTextStreamingModel<import("../../index.js").ChatPrompt, MistralChatPrompt, MistralChatModelSettings, this>;
     withJsonOutput(): this;
     withPromptTemplate<INPUT_PROMPT>(promptTemplate: TextGenerationPromptTemplate<INPUT_PROMPT, MistralChatPrompt>): PromptTemplateTextStreamingModel<INPUT_PROMPT, MistralChatPrompt, MistralChatModelSettings, this>;