modelfusion 0.6.0 → 0.7.0

package/README.md

@@ -10,9 +10,8 @@
 
 [Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Features](#features) | [Integrations](#integrations) | [Documentation](#documentation) | [Examples](#more-examples) | [modelfusion.dev](https://modelfusion.dev)
 
-## Disclaimer
-
-ModelFusion is in its initial development phase. Until version 1.0 there may be breaking changes.
+> [!NOTE]
+> ModelFusion is in its initial development phase. Until version 1.0 there may be breaking changes, because we are still exploring the API design. We welcome your feedback and suggestions.
 
 ## Introduction
 
@@ -49,7 +48,7 @@ You can use [prompt mappings](https://modelfusion.dev/guide/function/generate-te
 #### generateText
 
 ```ts
-const { text } = await generateText(
+const text = await generateText(
   new OpenAITextGenerationModel({ model: "text-davinci-003" }),
   "Write a short story about a robot learning to love:\n\n"
 );
@@ -58,7 +57,7 @@ const { text } = await generateText(
 #### streamText
 
 ```ts
-const { textStream } = await streamText(
+const textStream = await streamText(
   new OpenAIChatModel({ model: "gpt-3.5-turbo", maxTokens: 1000 }),
   [
     OpenAIChatMessage.system("You are a story writer."),
@@ -76,7 +75,7 @@ for await (const textFragment of textStream) {
 [Prompt mapping](https://modelfusion.dev/guide/function/generate-text/prompt-mapping) lets you use higher level prompt structures (such as instruction or chat prompts) for different models.
 
 ```ts
-const { text } = await generateText(
+const text = await generateText(
   new LlamaCppTextGenerationModel({
     contextWindowSize: 4096, // Llama 2 context window size
     nPredict: 1000,
@@ -89,7 +88,7 @@ const { text } = await generateText(
 ```
 
 ```ts
-const { textStream } = await streamText(
+const textStream = await streamText(
   new OpenAIChatModel({
     model: "gpt-3.5-turbo",
   }).mapPrompt(ChatToOpenAIChatPromptMapping()),
@@ -104,14 +103,15 @@ const { textStream } = await streamText(
 
 #### Metadata and original responses
 
-Most ModelFusion model functions return rich results that include the original response and metadata.
+ModelFusion model functions return rich results that include the original response and metadata when you set the `fullResponse` option to `true`.
 
 ```ts
 const { text, response, metadata } = await generateText(
   new OpenAITextGenerationModel({
     model: "text-davinci-003",
   }),
-  "Write a short story about a robot learning to love:\n\n"
+  "Write a short story about a robot learning to love:\n\n",
+  { fullResponse: true }
 );
 ```
 
@@ -120,7 +120,7 @@ const { text, response, metadata } = await generateText(
 Generate JSON value that matches a schema.
 
 ```ts
-const { value } = await generateJson(
+const value = await generateJson(
   new OpenAIChatModel({
     model: "gpt-3.5-turbo",
     temperature: 0,
@@ -249,7 +249,7 @@ const { tool, parameters, result, text } = await useToolOrGenerateText(
 Turn audio (voice) into text.
 
 ```ts
-const { transcription } = await transcribe(
+const transcription = await transcribe(
   new OpenAITranscriptionModel({ model: "whisper-1" }),
   {
     type: "mp3",
@@ -263,7 +263,7 @@ const { transcription } = await transcribe(
 Generate a base64-encoded image from a prompt.
 
 ```ts
-const { image } = await generateImage(
+const image = await generateImage(
   new OpenAIImageGenerationModel({ size: "512x512" }),
   "the wicked witch of the west in the style of early 19th century painting"
 );
@@ -274,7 +274,7 @@ const { image } = await generateImage(
 Create embeddings for text. Embeddings are vectors that represent the meaning of the text.
 
 ```ts
-const { embeddings } = await embedTexts(
+const embeddings = await embedTexts(
   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
   [
     "At first, Nox didn't know what to do with the pup.",
@@ -399,6 +399,7 @@ Use higher level prompts that are mapped into model specific prompt formats.
 - [Examples & Tutorials](https://modelfusion.dev/tutorial)
 - [Integrations](https://modelfusion.dev/integration/model-provider)
 - [API Reference](https://modelfusion.dev/api/modules)
+- [Blog](https://modelfusion.dev/api/blog)
 
 ## More Examples
 

package/composed-function/summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.cjs

@@ -18,7 +18,7 @@ async function summarizeRecursivelyWithTextGenerationAndTokenSplitting({ text, m
             maxTokensPerChunk: tokenLimit - emptyPromptTokens,
         }),
         summarize: async (input) => {
-            const { text } = await (0, generateText_js_1.generateText)(model, await prompt(input), options);
+            const text = await (0, generateText_js_1.generateText)(model, await prompt(input), options);
             return text;
         },
         join,

package/composed-function/summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.js

@@ -15,7 +15,7 @@ export async function summarizeRecursivelyWithTextGenerationAndTokenSplitting({
             maxTokensPerChunk: tokenLimit - emptyPromptTokens,
         }),
         summarize: async (input) => {
-            const { text } = await generateText(model, await prompt(input), options);
+            const text = await generateText(model, await prompt(input), options);
             return text;
         },
         join,

package/composed-function/use-tool/useTool.cjs

@@ -19,7 +19,10 @@ async function useTool(model, tool, prompt, options) {
         name: tool.name,
         description: tool.description,
         schema: tool.inputSchema,
-    }, () => prompt(tool), options);
+    }, () => prompt(tool), {
+        ...(options ?? {}),
+        fullResponse: true,
+    });
     return {
         tool: tool.name,
         parameters: value,

package/composed-function/use-tool/useTool.js

@@ -16,7 +16,10 @@ export async function useTool(model, tool, prompt, options) {
         name: tool.name,
         description: tool.description,
         schema: tool.inputSchema,
-    }, () => prompt(tool), options);
+    }, () => prompt(tool), {
+        ...(options ?? {}),
+        fullResponse: true,
+    });
     return {
         tool: tool.name,
         parameters: value,

package/model-function/embed-text/embedText.cjs

@@ -2,18 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.embedText = exports.embedTexts = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
-/**
- * Generate embeddings for multiple texts.
- *
- * @example
- * const { embeddings } = await embedTexts(
- *   new OpenAITextEmbeddingModel(...),
- *   [
- *     "At first, Nox didn't know what to do with the pup.",
- *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
- *   ]
- * );
- */
 async function embedTexts(model, texts, options) {
     const result = await (0, executeCall_js_1.executeCall)({
         model,
@@ -65,26 +53,24 @@ async function embedTexts(model, texts, options) {
             generatedEmbeddings: output,
         }),
     });
-    return {
-        embeddings: result.output,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            embeddings: result.output,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.embedTexts = embedTexts;
-/**
- * Generate an embedding for a single text.
- *
- * @example
- * const { embedding } = await embedText(
- *   new OpenAITextEmbeddingModel(...),
- *   "At first, Nox didn't know what to do with the pup."
- * );
- */
 async function embedText(model, text, options) {
-    const result = await embedTexts(model, [text], options);
-    return {
-        embedding: result.embeddings[0],
-        metadata: result.metadata,
-    };
+    const result = await embedTexts(model, [text], {
+        ...(options ?? {}),
+        fullResponse: true,
+    });
+    return options?.fullResponse === true
+        ? {
+            embedding: result.embeddings[0],
+            metadata: result.metadata,
+        }
+        : result.embeddings[0];
 }
 exports.embedText = embedText;

package/model-function/embed-text/embedText.d.ts

@@ -6,7 +6,7 @@ import { TextEmbeddingModel, TextEmbeddingModelSettings } from "./TextEmbeddingM
  * Generate embeddings for multiple texts.
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new OpenAITextEmbeddingModel(...),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",
@@ -14,20 +14,30 @@ import { TextEmbeddingModel, TextEmbeddingModelSettings } from "./TextEmbeddingM
  *   ]
  * );
  */
-export declare function embedTexts<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, texts: string[], options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function embedTexts<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, texts: string[], options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     embeddings: Array<Vector>;
     metadata: CallMetadata<TextEmbeddingModel<RESPONSE, SETTINGS>>;
 }>;
+export declare function embedTexts<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, texts: string[], options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<Array<Vector>>;
 /**
  * Generate an embedding for a single text.
  *
  * @example
- * const { embedding } = await embedText(
+ * const embedding = await embedText(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
  */
-export declare function embedText<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, text: string, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function embedText<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, text: string, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     embedding: Vector;
     metadata: CallMetadata<TextEmbeddingModel<RESPONSE, SETTINGS>>;
 }>;
+export declare function embedText<RESPONSE, SETTINGS extends TextEmbeddingModelSettings>(model: TextEmbeddingModel<RESPONSE, SETTINGS>, text: string, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<Vector>;

package/model-function/embed-text/embedText.js

@@ -1,16 +1,4 @@
 import { executeCall } from "../executeCall.js";
-/**
- * Generate embeddings for multiple texts.
- *
- * @example
- * const { embeddings } = await embedTexts(
- *   new OpenAITextEmbeddingModel(...),
- *   [
- *     "At first, Nox didn't know what to do with the pup.",
- *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
- *   ]
- * );
- */
 export async function embedTexts(model, texts, options) {
     const result = await executeCall({
         model,
@@ -62,24 +50,22 @@ export async function embedTexts(model, texts, options) {
             generatedEmbeddings: output,
         }),
     });
-    return {
-        embeddings: result.output,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            embeddings: result.output,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
-/**
- * Generate an embedding for a single text.
- *
- * @example
- * const { embedding } = await embedText(
- *   new OpenAITextEmbeddingModel(...),
- *   "At first, Nox didn't know what to do with the pup."
- * );
- */
 export async function embedText(model, text, options) {
-    const result = await embedTexts(model, [text], options);
-    return {
-        embedding: result.embeddings[0],
-        metadata: result.metadata,
-    };
+    const result = await embedTexts(model, [text], {
+        ...(options ?? {}),
+        fullResponse: true,
+    });
+    return options?.fullResponse === true
+        ? {
+            embedding: result.embeddings[0],
+            metadata: result.metadata,
+        }
+        : result.embeddings[0];
 }

package/model-function/generate-image/generateImage.cjs

@@ -2,21 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateImage = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
-/**
- * Generates a base64-encoded image using a prompt.
- * The prompt format depends on the model.
- * For example, OpenAI image models expect a string prompt,
- * and Stability AI models expect an array of text prompts with optional weights.
- *
- * @example
- * const { image } = await generateImage(
- *   new StabilityImageGenerationModel(...),
- *   [
- *     { text: "the wicked witch of the west" },
- *     { text: "style of early 19th century painting", weight: 0.5 },
- *   ]
- * );
- */
 async function generateImage(model, prompt, options) {
     const result = await (0, executeCall_js_1.executeCall)({
         model,
@@ -54,10 +39,12 @@ async function generateImage(model, prompt, options) {
             generatedImage: output,
         }),
     });
-    return {
-        image: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            image: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.generateImage = generateImage;

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

@@ -8,7 +8,7 @@ import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGener
  * and Stability AI models expect an array of text prompts with optional weights.
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new StabilityImageGenerationModel(...),
  *   [
  *     { text: "the wicked witch of the west" },
@@ -16,8 +16,13 @@ import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGener
  *   ]
  * );
  */
-export declare function generateImage<PROMPT, RESPONSE, SETTINGS extends ImageGenerationModelSettings>(model: ImageGenerationModel<PROMPT, RESPONSE, SETTINGS>, prompt: PROMPT, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function generateImage<PROMPT, RESPONSE, SETTINGS extends ImageGenerationModelSettings>(model: ImageGenerationModel<PROMPT, RESPONSE, SETTINGS>, prompt: PROMPT, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     image: string;
     response: RESPONSE;
     metadata: CallMetadata<ImageGenerationModel<PROMPT, RESPONSE, SETTINGS>>;
 }>;
+export declare function generateImage<PROMPT, RESPONSE, SETTINGS extends ImageGenerationModelSettings>(model: ImageGenerationModel<PROMPT, RESPONSE, SETTINGS>, prompt: PROMPT, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<string>;

package/model-function/generate-image/generateImage.js

@@ -1,19 +1,4 @@
 import { executeCall } from "../executeCall.js";
-/**
- * Generates a base64-encoded image using a prompt.
- * The prompt format depends on the model.
- * For example, OpenAI image models expect a string prompt,
- * and Stability AI models expect an array of text prompts with optional weights.
- *
- * @example
- * const { image } = await generateImage(
- *   new StabilityImageGenerationModel(...),
- *   [
- *     { text: "the wicked witch of the west" },
- *     { text: "style of early 19th century painting", weight: 0.5 },
- *   ]
- * );
- */
 export async function generateImage(model, prompt, options) {
     const result = await executeCall({
         model,
@@ -51,9 +36,11 @@ export async function generateImage(model, prompt, options) {
             generatedImage: output,
         }),
     });
-    return {
-        image: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            image: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }

package/model-function/generate-json/generateJson.cjs

@@ -52,10 +52,12 @@ async function generateJson(model, schemaDefinition, prompt, options) {
             generatedJson: output,
         }),
     });
-    return {
-        value: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            value: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.generateJson = generateJson;

package/model-function/generate-json/generateJson.d.ts

@@ -2,8 +2,13 @@ import { FunctionOptions } from "../FunctionOptions.js";
 import { CallMetadata } from "../executeCall.js";
 import { GenerateJsonModel, GenerateJsonModelSettings, GenerateJsonPrompt } from "./GenerateJsonModel.js";
 import { SchemaDefinition } from "./SchemaDefinition.js";
-export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT & GenerateJsonPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT & GenerateJsonPrompt<RESPONSE>, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     value: STRUCTURE;
     response: RESPONSE;
     metadata: CallMetadata<GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>>;
 }>;
+export declare function generateJson<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends GenerateJsonModelSettings>(model: GenerateJsonModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinition: SchemaDefinition<NAME, STRUCTURE>, prompt: (schemaDefinition: SchemaDefinition<NAME, STRUCTURE>) => PROMPT & GenerateJsonPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<STRUCTURE>;

package/model-function/generate-json/generateJson.js

@@ -49,9 +49,11 @@ export async function generateJson(model, schemaDefinition, prompt, options) {
             generatedJson: output,
         }),
     });
-    return {
-        value: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            value: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }

package/model-function/generate-json/generateJsonOrText.cjs

@@ -65,10 +65,12 @@ async function generateJsonOrText(model, schemaDefinitions, prompt, options) {
             generatedJson: output,
         }),
     });
-    return {
-        ...result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            ...result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.generateJsonOrText = generateJsonOrText;

package/model-function/generate-json/generateJsonOrText.d.ts

@@ -14,7 +14,9 @@ type ToSchemaUnion<T> = {
     } : never;
 }[keyof T];
 type ToOutputValue<SCHEMAS extends SchemaDefinitionArray<SchemaDefinition<any, any>[]>> = ToSchemaUnion<ToSchemaDefinitionsMap<SCHEMAS>>;
-export declare function generateJsonOrText<SCHEMAS extends SchemaDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends GenerateJsonOrTextModelSettings>(model: GenerateJsonOrTextModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinitions: SCHEMAS, prompt: (schemaDefinitions: SCHEMAS) => PROMPT & GenerateJsonOrTextPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS>): Promise<({
+export declare function generateJsonOrText<SCHEMAS extends SchemaDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends GenerateJsonOrTextModelSettings>(model: GenerateJsonOrTextModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinitions: SCHEMAS, prompt: (schemaDefinitions: SCHEMAS) => PROMPT & GenerateJsonOrTextPrompt<RESPONSE>, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<({
     schema: null;
     value: null;
     text: string;
@@ -22,4 +24,11 @@ export declare function generateJsonOrText<SCHEMAS extends SchemaDefinition<any,
     response: RESPONSE;
     metadata: CallMetadata<GenerateJsonOrTextModel<PROMPT, RESPONSE, SETTINGS>>;
 }>;
+export declare function generateJsonOrText<SCHEMAS extends SchemaDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends GenerateJsonOrTextModelSettings>(model: GenerateJsonOrTextModel<PROMPT, RESPONSE, SETTINGS>, schemaDefinitions: SCHEMAS, prompt: (schemaDefinitions: SCHEMAS) => PROMPT & GenerateJsonOrTextPrompt<RESPONSE>, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<{
+    schema: null;
+    value: null;
+    text: string;
+} | ToOutputValue<SCHEMAS>>;
 export {};

package/model-function/generate-json/generateJsonOrText.js

@@ -62,9 +62,11 @@ export async function generateJsonOrText(model, schemaDefinitions, prompt, optio
             generatedJson: output,
         }),
     });
-    return {
-        ...result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            ...result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }

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

@@ -2,18 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateText = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
-/**
- * Generates a text using a prompt.
- * The prompt format depends on the model.
- * For example, OpenAI text models expect a string prompt, and OpenAI chat models expect an array of chat messages.
- *
- * @example
- * const model = new OpenAITextGenerationModel(...);
- *
- * const { text } = await model.generateText(
- *   "Write a short story about a robot learning to love:\n\n"
- * );
- */
 async function generateText(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 model, prompt, options) {
@@ -58,10 +46,12 @@ model, prompt, options) {
             generatedText: output,
         }),
     });
-    return {
-        text: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            text: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.generateText = generateText;

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

@@ -9,12 +9,17 @@ import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerati
  * @example
  * const model = new OpenAITextGenerationModel(...);
  *
- * const { text } = await model.generateText(
+ * const text = await model.generateText(
  *   "Write a short story about a robot learning to love:\n\n"
  * );
  */
-export declare function generateText<PROMPT, RESPONSE, SETTINGS extends TextGenerationModelSettings>(model: TextGenerationModel<PROMPT, RESPONSE, any, SETTINGS>, prompt: PROMPT, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function generateText<PROMPT, RESPONSE, SETTINGS extends TextGenerationModelSettings>(model: TextGenerationModel<PROMPT, RESPONSE, any, SETTINGS>, prompt: PROMPT, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     text: string;
     response: RESPONSE;
     metadata: CallMetadata<TextGenerationModel<PROMPT, RESPONSE, unknown, SETTINGS>>;
 }>;
+export declare function generateText<PROMPT, RESPONSE, SETTINGS extends TextGenerationModelSettings>(model: TextGenerationModel<PROMPT, RESPONSE, any, SETTINGS>, prompt: PROMPT, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<string>;

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

@@ -1,16 +1,4 @@
 import { executeCall } from "../executeCall.js";
-/**
- * Generates a text using a prompt.
- * The prompt format depends on the model.
- * For example, OpenAI text models expect a string prompt, and OpenAI chat models expect an array of chat messages.
- *
- * @example
- * const model = new OpenAITextGenerationModel(...);
- *
- * const { text } = await model.generateText(
- *   "Write a short story about a robot learning to love:\n\n"
- * );
- */
 export async function generateText(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 model, prompt, options) {
@@ -55,9 +43,11 @@ model, prompt, options) {
             generatedText: output,
         }),
     });
-    return {
-        text: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            text: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }

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

@@ -107,9 +107,11 @@ async function streamText(model, prompt, options) {
         });
         throw result.error;
     }
-    return {
-        textStream: result.output,
-        metadata: startMetadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            textStream: result.output,
+            metadata: startMetadata,
+        }
+        : result.output;
 }
 exports.streamText = streamText;

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

@@ -5,7 +5,15 @@ import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerati
 export declare function streamText<PROMPT, FULL_DELTA, SETTINGS extends TextGenerationModelSettings>(model: TextGenerationModel<PROMPT, unknown, FULL_DELTA, SETTINGS> & {
     generateDeltaStreamResponse: (prompt: PROMPT, options: FunctionOptions<SETTINGS>) => PromiseLike<AsyncIterable<DeltaEvent<FULL_DELTA>>>;
     extractTextDelta: (fullDelta: FULL_DELTA) => string | undefined;
-}, prompt: PROMPT, options?: FunctionOptions<SETTINGS>): Promise<{
+}, prompt: PROMPT, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<AsyncIterable<string>>;
+export declare function streamText<PROMPT, FULL_DELTA, SETTINGS extends TextGenerationModelSettings>(model: TextGenerationModel<PROMPT, unknown, FULL_DELTA, SETTINGS> & {
+    generateDeltaStreamResponse: (prompt: PROMPT, options: FunctionOptions<SETTINGS>) => PromiseLike<AsyncIterable<DeltaEvent<FULL_DELTA>>>;
+    extractTextDelta: (fullDelta: FULL_DELTA) => string | undefined;
+}, prompt: PROMPT, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     textStream: AsyncIterable<string>;
     metadata: Omit<CallMetadata<TextGenerationModel<PROMPT, unknown, FULL_DELTA, SETTINGS>>, "durationInMs">;
 }>;

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

@@ -104,8 +104,10 @@ export async function streamText(model, prompt, options) {
         });
         throw result.error;
     }
-    return {
-        textStream: result.output,
-        metadata: startMetadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            textStream: result.output,
+            metadata: startMetadata,
+        }
+        : result.output;
 }

package/model-function/transcribe-audio/transcribe.cjs

@@ -2,20 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transcribe = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
-/**
- * Transcribe audio data into text.
- *
- * @example
- * const data = await fs.promises.readFile("data/test.mp3");
- *
- * const { transcription } = await transcribe(
- *   new OpenAITranscriptionModel({ model: "whisper-1" }),
- *   {
- *     type: "mp3",
- *     data,
- *   }
- * );
- */
 async function transcribe(model, data, options) {
     const result = await (0, executeCall_js_1.executeCall)({
         model,
@@ -53,10 +39,12 @@ async function transcribe(model, data, options) {
             transcription: output,
         }),
     });
-    return {
-        transcription: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            transcription: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }
 exports.transcribe = transcribe;

package/model-function/transcribe-audio/transcribe.d.ts

@@ -7,7 +7,7 @@ import { TranscriptionModel, TranscriptionModelSettings } from "./TranscriptionM
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const { transcription } = await transcribe(
+ * const transcription = await transcribe(
  *   new OpenAITranscriptionModel({ model: "whisper-1" }),
  *   {
  *     type: "mp3",
@@ -15,8 +15,13 @@ import { TranscriptionModel, TranscriptionModelSettings } from "./TranscriptionM
  *   }
  * );
  */
-export declare function transcribe<DATA, RESPONSE, SETTINGS extends TranscriptionModelSettings>(model: TranscriptionModel<DATA, RESPONSE, SETTINGS>, data: DATA, options?: FunctionOptions<SETTINGS>): Promise<{
+export declare function transcribe<DATA, RESPONSE, SETTINGS extends TranscriptionModelSettings>(model: TranscriptionModel<DATA, RESPONSE, SETTINGS>, data: DATA, options: FunctionOptions<SETTINGS> & {
+    fullResponse: true;
+}): Promise<{
     transcription: string;
     response: RESPONSE;
     metadata: CallMetadata<TranscriptionModel<DATA, RESPONSE, SETTINGS>>;
 }>;
+export declare function transcribe<DATA, RESPONSE, SETTINGS extends TranscriptionModelSettings>(model: TranscriptionModel<DATA, RESPONSE, SETTINGS>, data: DATA, options?: FunctionOptions<SETTINGS> & {
+    fullResponse?: false;
+}): Promise<string>;

package/model-function/transcribe-audio/transcribe.js

@@ -1,18 +1,4 @@
 import { executeCall } from "../executeCall.js";
-/**
- * Transcribe audio data into text.
- *
- * @example
- * const data = await fs.promises.readFile("data/test.mp3");
- *
- * const { transcription } = await transcribe(
- *   new OpenAITranscriptionModel({ model: "whisper-1" }),
- *   {
- *     type: "mp3",
- *     data,
- *   }
- * );
- */
 export async function transcribe(model, data, options) {
     const result = await executeCall({
         model,
@@ -50,9 +36,11 @@ export async function transcribe(model, data, options) {
             transcription: output,
         }),
     });
-    return {
-        transcription: result.output,
-        response: result.response,
-        metadata: result.metadata,
-    };
+    return options?.fullResponse === true
+        ? {
+            transcription: result.output,
+            response: result.response,
+            metadata: result.metadata,
+        }
+        : result.output;
 }

package/model-provider/cohere/CohereTextEmbeddingModel.cjs

@@ -30,7 +30,7 @@ exports.COHERE_TEXT_EMBEDDING_MODELS = {
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

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

@@ -38,7 +38,7 @@ export interface CohereTextEmbeddingModelSettings extends TextEmbeddingModelSett
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/cohere/CohereTextEmbeddingModel.js

@@ -24,7 +24,7 @@ export const COHERE_TEXT_EMBEDDING_MODELS = {
  * @see https://docs.cohere.com/reference/embed
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new CohereTextEmbeddingModel({ model: "embed-english-light-v2.0" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/cohere/CohereTextGenerationModel.cjs

@@ -40,7 +40,7 @@ exports.COHERE_TEXT_GENERATION_MODELS = {
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *    model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

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

@@ -59,7 +59,7 @@ export interface CohereTextGenerationModelSettings extends TextGenerationModelSe
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *    model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/cohere/CohereTextGenerationModel.js

@@ -34,7 +34,7 @@ export const COHERE_TEXT_GENERATION_MODELS = {
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *    model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.cjs

@@ -21,7 +21,7 @@ const HuggingFaceError_js_1 = require("./HuggingFaceError.cjs");
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

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

@@ -29,7 +29,7 @@ export interface HuggingFaceTextEmbeddingModelSettings extends TextEmbeddingMode
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.js

@@ -15,7 +15,7 @@ import { failedHuggingFaceCallResponseHandler } from "./HuggingFaceError.js";
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   model,
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/huggingface/HuggingFaceTextGenerationModel.cjs

@@ -23,7 +23,7 @@ const PromptMappingTextGenerationModel_js_1 = require("../../prompt/PromptMappin
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

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

@@ -38,7 +38,7 @@ export interface HuggingFaceTextGenerationModelSettings extends TextGenerationMo
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/huggingface/HuggingFaceTextGenerationModel.js

@@ -17,7 +17,7 @@ import { PromptMappingTextGenerationModel } from "../../prompt/PromptMappingText
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/openai/OpenAIImageGenerationModel.cjs

@@ -22,7 +22,7 @@ exports.calculateOpenAIImageGenerationCostInMillicents = calculateOpenAIImageGen
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new OpenAIImageGenerationModel({ size: "512x512" }),
  *   "the wicked witch of the west in the style of early 19th century painting"
  * );

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

@@ -20,7 +20,7 @@ export interface OpenAIImageGenerationSettings extends ImageGenerationModelSetti
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new OpenAIImageGenerationModel({ size: "512x512" }),
  *   "the wicked witch of the west in the style of early 19th century painting"
  * );

package/model-provider/openai/OpenAIImageGenerationModel.js

@@ -18,7 +18,7 @@ export const calculateOpenAIImageGenerationCostInMillicents = ({ settings, }) =>
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new OpenAIImageGenerationModel({ size: "512x512" }),
  *   "the wicked witch of the west in the style of early 19th century painting"
  * );

package/model-provider/openai/OpenAITextEmbeddingModel.cjs

@@ -36,7 +36,7 @@ exports.calculateOpenAIEmbeddingCostInMillicents = calculateOpenAIEmbeddingCostI
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

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

@@ -32,7 +32,7 @@ export interface OpenAITextEmbeddingModelSettings extends TextEmbeddingModelSett
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/openai/OpenAITextEmbeddingModel.js

@@ -28,7 +28,7 @@ export const calculateOpenAIEmbeddingCostInMillicents = ({ model, responses, })
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const { embeddings } = await embedTexts(
+ * const embeddings = await embedTexts(
  *   new OpenAITextEmbeddingModel({ model: "text-embedding-ada-002" }),
  *   [
  *     "At first, Nox didn't know what to do with the pup.",

package/model-provider/openai/OpenAITextGenerationModel.cjs

@@ -79,7 +79,7 @@ exports.calculateOpenAITextGenerationCostInMillicents = calculateOpenAITextGener
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

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

@@ -96,7 +96,7 @@ export interface OpenAITextGenerationModelSettings extends TextGenerationModelSe
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/openai/OpenAITextGenerationModel.js

@@ -71,7 +71,7 @@ export const calculateOpenAITextGenerationCostInMillicents = ({ model, response,
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const { text } = await generateText(
+ * const text = await generateText(
  *   model,
  *   "Write a short story about a robot learning to love:\n\n"
  * );

package/model-provider/openai/OpenAITranscriptionModel.cjs

@@ -34,7 +34,7 @@ exports.calculateOpenAITranscriptionCostInMillicents = calculateOpenAITranscript
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const { transcription } = await transcribe(
+ * const transcription = await transcribe(
  *   new OpenAITranscriptionModel({ model: "whisper-1" }),
  *   {
  *     type: "mp3",

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

@@ -39,7 +39,7 @@ export type OpenAITranscriptionInput = {
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const { transcription } = await transcribe(
+ * const transcription = await transcribe(
  *   new OpenAITranscriptionModel({ model: "whisper-1" }),
  *   {
  *     type: "mp3",

package/model-provider/openai/OpenAITranscriptionModel.js

@@ -27,7 +27,7 @@ export const calculateOpenAITranscriptionCostInMillicents = ({ model, response,
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const { transcription } = await transcribe(
+ * const transcription = await transcribe(
  *   new OpenAITranscriptionModel({ model: "whisper-1" }),
  *   {
  *     type: "mp3",

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

@@ -95,7 +95,7 @@ exports.calculateOpenAIChatCostInMillicents = calculateOpenAIChatCostInMillicent
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText([
+ * const text = await generateText([
  *   model,
  *   OpenAIChatMessage.system(
  *     "Write a short story about a robot learning to love:"

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

@@ -109,7 +109,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, OpenAIM
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText([
+ * const text = await generateText([
  *   model,
  *   OpenAIChatMessage.system(
  *     "Write a short story about a robot learning to love:"

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

@@ -87,7 +87,7 @@ export const calculateOpenAIChatCostInMillicents = ({ model, response, }) => res
  *   maxTokens: 500,
  * });
  *
- * const { text } = await generateText([
+ * const text = await generateText([
  *   model,
  *   OpenAIChatMessage.system(
  *     "Write a short story about a robot learning to love:"

package/model-provider/stability/StabilityImageGenerationModel.cjs

@@ -12,7 +12,7 @@ const StabilityError_js_1 = require("./StabilityError.cjs");
  * @see https://api.stability.ai/docs#tag/v1generation/operation/textToImage
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new StabilityImageGenerationModel({
  *     model: "stable-diffusion-512-v2-1",
  *     cfgScale: 7,

package/model-provider/stability/StabilityImageGenerationModel.d.ts

@@ -10,7 +10,7 @@ import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
  * @see https://api.stability.ai/docs#tag/v1generation/operation/textToImage
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new StabilityImageGenerationModel({
  *     model: "stable-diffusion-512-v2-1",
  *     cfgScale: 7,

package/model-provider/stability/StabilityImageGenerationModel.js

@@ -9,7 +9,7 @@ import { failedStabilityCallResponseHandler } from "./StabilityError.js";
  * @see https://api.stability.ai/docs#tag/v1generation/operation/textToImage
  *
  * @example
- * const { image } = await generateImage(
+ * const image = await generateImage(
  *   new StabilityImageGenerationModel({
  *     model: "stable-diffusion-512-v2-1",
  *     cfgScale: 7,

package/package.json

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

package/text-chunk/SimilarTextChunksFromVectorIndexRetriever.cjs

@@ -36,7 +36,7 @@ class SimilarTextChunksFromVectorIndexRetriever {
                 run: options.run,
             });
         }
-        const { embedding } = await (0, embedText_js_1.embedText)(this.embeddingModel, query, {
+        const embedding = await (0, embedText_js_1.embedText)(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,
         });

package/text-chunk/SimilarTextChunksFromVectorIndexRetriever.js

@@ -33,7 +33,7 @@ export class SimilarTextChunksFromVectorIndexRetriever {
                 run: options.run,
             });
         }
-        const { embedding } = await embedText(this.embeddingModel, query, {
+        const embedding = await embedText(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,
         });

package/text-chunk/upsertTextChunks.cjs

@@ -5,7 +5,7 @@ const nanoid_1 = require("nanoid");
 const embedText_js_1 = require("../model-function/embed-text/embedText.cjs");
 async function upsertTextChunks({ vectorIndex, embeddingModel, generateId = nanoid_1.nanoid, chunks, ids, }, options) {
     // many embedding models support bulk embedding, so we first embed all texts:
-    const { embeddings } = await (0, embedText_js_1.embedTexts)(embeddingModel, chunks.map((chunk) => chunk.text), options);
+    const embeddings = await (0, embedText_js_1.embedTexts)(embeddingModel, chunks.map((chunk) => chunk.text), options);
     await vectorIndex.upsertMany(chunks.map((chunk, i) => ({
         id: ids?.[i] ?? generateId(),
         vector: embeddings[i],

package/text-chunk/upsertTextChunks.js

@@ -2,7 +2,7 @@ import { nanoid as createId } from "nanoid";
 import { embedTexts } from "../model-function/embed-text/embedText.js";
 export async function upsertTextChunks({ vectorIndex, embeddingModel, generateId = createId, chunks, ids, }, options) {
     // many embedding models support bulk embedding, so we first embed all texts:
-    const { embeddings } = await embedTexts(embeddingModel, chunks.map((chunk) => chunk.text), options);
+    const embeddings = await embedTexts(embeddingModel, chunks.map((chunk) => chunk.text), options);
     await vectorIndex.upsertMany(chunks.map((chunk, i) => ({
         id: ids?.[i] ?? generateId(),
         vector: embeddings[i],