modelfusion 0.97.0 → 0.98.0

package/README.md

@@ -85,7 +85,10 @@ Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai),
 Multi-modal vision models such as GPT 4 Vision can process images as part of the prompt.
 
 ```ts
-import { streamText, openai } from "modelfusion";
+import { streamText, openai, OpenAIChatMessage } from "modelfusion";
+import { readFileSync } from "fs";
+
+const image = readFileSync("./image.png").toString("base64");
 
 const textStream = await streamText(
   openai.ChatTextGenerator({ model: "gpt-4-vision-preview" }),
@@ -96,9 +99,13 @@ const textStream = await streamText(
     ]),
   ]
 );
+
+for await (const textPart of textStream) {
+  process.stdout.write(textPart);
+}
 ```
 
-Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp)
+Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [OpenAI compatible](https://modelfusion.dev/integration/model-provider/openaicompatible), [Llama.cpp](https://modelfusion.dev/integration/model-provider/llamacpp), [Ollama](https://modelfusion.dev/integration/model-provider/ollama)
 
 ### [Generate Image](https://modelfusion.dev/guide/function/generate-image)
 
@@ -608,7 +615,7 @@ const image = await generateImage(
 
 ### Metadata and original responses
 
-ModelFusion model functions return rich results that include the original response and metadata when you set the `returnType` option to `full`.
+ModelFusion model functions return rich responses that include the original response and metadata when you set the `fullResponse` option to `true`.
 
 ```ts
 // access the full response (needs to be typed) and the metadata:
@@ -619,7 +626,7 @@ const { value, response, metadata } = await generateText(
     n: 2, // generate 2 completions
   }),
   "Write a short story about a robot learning to love:\n\n",
-  { returnType: "full" }
+  { fullResponse: true }
 );
 
 console.log(metadata);

package/model-function/embed/embed.cjs

@@ -43,7 +43,13 @@ async function embedMany(model, values, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            embeddings: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.embedMany = embedMany;
 async function embed(model, value, options) {
@@ -60,6 +66,12 @@ async function embed(model, value, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            embedding: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.embed = embed;

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

@@ -23,12 +23,12 @@ import { EmbeddingModel, EmbeddingModelSettings } from "./EmbeddingModel.js";
  * @returns {Promise<Vector[]>} - A promise that resolves to an array of vectors representing the embeddings.
  */
 export declare function embedMany<VALUE>(model: EmbeddingModel<VALUE, EmbeddingModelSettings>, values: VALUE[], options?: FunctionOptions & {
-    returnType?: "vectors";
+    fullResponse?: false;
 }): Promise<Vector[]>;
 export declare function embedMany<VALUE>(model: EmbeddingModel<VALUE, EmbeddingModelSettings>, values: VALUE[], options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: Vector[];
+    embeddings: Vector[];
     response: unknown;
     metadata: ModelCallMetadata;
 }>;
@@ -50,12 +50,12 @@ export declare function embedMany<VALUE>(model: EmbeddingModel<VALUE, EmbeddingM
  * @returns {Promise<Vector>} - A promise that resolves to a vector representing the embedding.
  */
 export declare function embed<VALUE>(model: EmbeddingModel<VALUE, EmbeddingModelSettings>, value: VALUE, options?: FunctionOptions & {
-    returnType?: "vector";
+    fullResponse?: false;
 }): Promise<Vector>;
 export declare function embed<VALUE>(model: EmbeddingModel<VALUE, EmbeddingModelSettings>, value: VALUE, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: Vector;
+    embedding: Vector;
     response: unknown;
     metadata: ModelCallMetadata;
 }>;

package/model-function/embed/embed.js

@@ -40,7 +40,13 @@ export async function embedMany(model, values, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            embeddings: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 export async function embed(model, value, options) {
     const fullResponse = await executeStandardCall({
@@ -56,5 +62,11 @@ export async function embed(model, value, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            embedding: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

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

@@ -16,14 +16,15 @@ async function generateImage(model, prompt, options) {
             };
         },
     });
-    switch (options?.returnType) {
-        case "full":
-            return fullResponse;
-        case "base64":
-            return fullResponse.value;
-        case "buffer":
-        default:
-            return Buffer.from(fullResponse.value, "base64");
-    }
+    const imageBase64 = fullResponse.value;
+    const image = Buffer.from(imageBase64, "base64");
+    return options?.fullResponse
+        ? {
+            image,
+            imageBase64,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : image;
 }
 exports.generateImage = generateImage;

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

@@ -27,15 +27,13 @@ import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGener
  * The image is a Buffer containing the image data in PNG format.
  */
 export declare function generateImage<PROMPT>(model: ImageGenerationModel<PROMPT, ImageGenerationModelSettings>, prompt: PROMPT, options?: FunctionOptions & {
-    returnType?: "buffer";
+    fullResponse?: false;
 }): Promise<Buffer>;
 export declare function generateImage<PROMPT>(model: ImageGenerationModel<PROMPT, ImageGenerationModelSettings>, prompt: PROMPT, options: FunctionOptions & {
-    returnType: "base64";
-}): Promise<string>;
-export declare function generateImage<PROMPT>(model: ImageGenerationModel<PROMPT, ImageGenerationModelSettings>, prompt: PROMPT, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: string;
+    image: Buffer;
+    imageBase64: string;
     response: unknown;
     metadata: ModelCallMetadata;
 }>;

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

@@ -13,13 +13,14 @@ export async function generateImage(model, prompt, options) {
             };
         },
     });
-    switch (options?.returnType) {
-        case "full":
-            return fullResponse;
-        case "base64":
-            return fullResponse.value;
-        case "buffer":
-        default:
-            return Buffer.from(fullResponse.value, "base64");
-    }
+    const imageBase64 = fullResponse.value;
+    const image = Buffer.from(imageBase64, "base64");
+    return options?.fullResponse
+        ? {
+            image,
+            imageBase64,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : image;
 }

package/model-function/generate-speech/generateSpeech.cjs

@@ -16,6 +16,12 @@ async function generateSpeech(model, text, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            speech: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.generateSpeech = generateSpeech;

package/model-function/generate-speech/generateSpeech.d.ts

@@ -21,12 +21,12 @@ import { SpeechGenerationModel, SpeechGenerationModelSettings } from "./SpeechGe
  * @returns {Promise<Buffer>} - A promise that resolves to a buffer containing the synthesized speech.
  */
 export declare function generateSpeech(model: SpeechGenerationModel<SpeechGenerationModelSettings>, text: string, options?: FunctionOptions & {
-    returnType?: "buffer";
+    fullResponse?: false;
 }): Promise<Buffer>;
 export declare function generateSpeech(model: SpeechGenerationModel<SpeechGenerationModelSettings>, text: string, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: Buffer;
+    speech: Buffer;
     response: unknown;
     metadata: ModelCallMetadata;
 }>;

package/model-function/generate-speech/generateSpeech.js

@@ -13,5 +13,11 @@ export async function generateSpeech(model, text, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            speech: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

package/model-function/generate-speech/streamSpeech.cjs

@@ -24,6 +24,11 @@ async function streamSpeech(model, text, options) {
         processDelta: (delta) => delta.valueDelta,
         getResult: () => ({}),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            speechStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.streamSpeech = streamSpeech;

package/model-function/generate-speech/streamSpeech.d.ts

@@ -27,11 +27,11 @@ import { SpeechGenerationModelSettings, StreamingSpeechGenerationModel } from ".
  * @returns {AsyncIterableResultPromise<Buffer>} An async iterable promise that contains the synthesized speech chunks.
  */
 export declare function streamSpeech(model: StreamingSpeechGenerationModel<SpeechGenerationModelSettings>, text: AsyncIterable<string> | string, options?: FunctionOptions & {
-    returnType?: "buffer-stream";
+    fullResponse?: false;
 }): Promise<AsyncIterable<Buffer>>;
 export declare function streamSpeech(model: StreamingSpeechGenerationModel<SpeechGenerationModelSettings>, text: AsyncIterable<string> | string, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: AsyncIterable<Buffer>;
+    speechStream: AsyncIterable<Buffer>;
     metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
 }>;

package/model-function/generate-speech/streamSpeech.js

@@ -21,5 +21,10 @@ export async function streamSpeech(model, text, options) {
         processDelta: (delta) => delta.valueDelta,
         getResult: () => ({}),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            speechStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

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

@@ -30,20 +30,20 @@ class StructureFromTextGenerationModel {
         return this.model.settingsForEvent;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
+        const { response, text } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
-            returnType: "full",
+            fullResponse: true,
         });
         try {
             return {
                 response,
-                value: this.template.extractStructure(value),
-                valueText: value,
+                value: this.template.extractStructure(text),
+                valueText: text,
             };
         }
         catch (error) {
             throw new StructureParseError_js_1.StructureParseError({
-                valueText: value,
+                valueText: text,
                 cause: error,
             });
         }

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

@@ -27,20 +27,20 @@ export class StructureFromTextGenerationModel {
         return this.model.settingsForEvent;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
+        const { response, text } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
-            returnType: "full",
+            fullResponse: true,
         });
         try {
             return {
                 response,
-                value: this.template.extractStructure(value),
-                valueText: value,
+                value: this.template.extractStructure(text),
+                valueText: text,
             };
         }
         catch (error) {
             throw new StructureParseError({
-                valueText: value,
+                valueText: text,
                 cause: error,
             });
         }

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

@@ -41,20 +41,20 @@ class StructureFromTextStreamingModel extends StructureFromTextGenerationModel_j
         return queue;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
+        const { response, text } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
-            returnType: "full",
+            fullResponse: true,
         });
         try {
             return {
                 response,
-                value: this.template.extractStructure(value),
-                valueText: value,
+                value: this.template.extractStructure(text),
+                valueText: text,
             };
         }
         catch (error) {
             throw new StructureParseError_js_1.StructureParseError({
-                valueText: value,
+                valueText: text,
                 cause: error,
             });
         }

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

@@ -38,20 +38,20 @@ export class StructureFromTextStreamingModel extends StructureFromTextGeneration
         return queue;
     }
     async doGenerateStructure(schema, prompt, options) {
-        const { response, value } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
+        const { response, text } = await generateText(this.model, this.template.createPrompt(prompt, schema), {
             ...options,
-            returnType: "full",
+            fullResponse: true,
         });
         try {
             return {
                 response,
-                value: this.template.extractStructure(value),
-                valueText: value,
+                value: this.template.extractStructure(text),
+                valueText: text,
             };
         }
         catch (error) {
             throw new StructureParseError({
-                valueText: value,
+                valueText: text,
                 cause: error,
             });
         }

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

@@ -32,6 +32,12 @@ async function generateStructure(model, schema, prompt, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            structure: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.generateStructure = generateStructure;

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

@@ -38,12 +38,12 @@ import { StructureGenerationModel, StructureGenerationModelSettings } from "./St
  * @returns {Promise<STRUCTURE>} - Returns a promise that resolves to the generated structure.
  */
 export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options?: FunctionOptions & {
-    returnType?: "structure";
+    fullResponse?: false;
 }): Promise<STRUCTURE>;
 export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: STRUCTURE;
+    structure: STRUCTURE;
     response: unknown;
     metadata: ModelCallMetadata;
 }>;

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

@@ -29,5 +29,11 @@ export async function generateStructure(model, schema, prompt, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            structure: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

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

@@ -47,6 +47,11 @@ async function streamStructure(model, schema, prompt, options) {
             value: lastStructure,
         }),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            structureStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.streamStructure = streamStructure;

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

@@ -69,11 +69,11 @@ export type StructureStreamPart<STRUCTURE> = {
  * and a value that is either the partial structure or the final structure.
  */
 export declare function streamStructure<STRUCTURE, PROMPT>(model: StructureStreamingModel<PROMPT>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options?: FunctionOptions & {
-    returnType?: "structure-stream";
+    fullResponse?: false;
 }): Promise<AsyncIterable<StructureStreamPart<STRUCTURE>>>;
 export declare function streamStructure<STRUCTURE, PROMPT>(model: StructureStreamingModel<PROMPT>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: AsyncIterable<StructureStreamPart<STRUCTURE>>;
+    structureStream: AsyncIterable<StructureStreamPart<STRUCTURE>>;
     metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
 }>;

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

@@ -44,5 +44,10 @@ export async function streamStructure(model, schema, prompt, options) {
             value: lastStructure,
         }),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            structureStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

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

@@ -18,6 +18,12 @@ async function generateText(model, prompt, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            text: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.generateText = generateText;

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

@@ -23,12 +23,12 @@ import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerati
  * @returns {Promise<string>} - A promise that resolves to the generated text.
  */
 export declare function generateText<PROMPT>(model: TextGenerationModel<PROMPT, TextGenerationModelSettings>, prompt: PROMPT, options?: FunctionOptions & {
-    returnType?: "text";
+    fullResponse?: false;
 }): Promise<string>;
 export declare function generateText<PROMPT>(model: TextGenerationModel<PROMPT, TextGenerationModelSettings>, prompt: PROMPT, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: string;
+    text: string;
     response: unknown;
     metadata: ModelCallMetadata;
 }>;

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

@@ -15,5 +15,11 @@ export async function generateText(model, prompt, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            text: fullResponse.value,
+            response: fullResponse.response,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

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

@@ -45,6 +45,11 @@ async function streamText(model, prompt, options) {
             value: accumulatedText,
         }),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            textStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }
 exports.streamText = streamText;

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

@@ -27,11 +27,11 @@ import { TextStreamingModel } from "./TextGenerationModel.js";
  * @returns {AsyncIterableResultPromise<string>} An async iterable promise that yields the generated text.
  */
 export declare function streamText<PROMPT>(model: TextStreamingModel<PROMPT>, prompt: PROMPT, options?: FunctionOptions & {
-    returnType?: "text-stream";
+    fullResponse?: false;
 }): Promise<AsyncIterable<string>>;
 export declare function streamText<PROMPT>(model: TextStreamingModel<PROMPT>, prompt: PROMPT, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
-    value: AsyncIterable<string>;
+    textStream: AsyncIterable<string>;
     metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
 }>;

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

@@ -42,5 +42,10 @@ export async function streamText(model, prompt, options) {
             value: accumulatedText,
         }),
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse
+        ? {
+            textStream: fullResponse.value,
+            metadata: fullResponse.metadata,
+        }
+        : fullResponse.value;
 }

package/model-function/generate-transcription/generateTranscription.cjs

@@ -16,6 +16,6 @@ async function generateTranscription(model, data, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse ? fullResponse : fullResponse.value;
 }
 exports.generateTranscription = generateTranscription;

package/model-function/generate-transcription/generateTranscription.d.ts

@@ -21,10 +21,10 @@ import { TranscriptionModel, TranscriptionModelSettings } from "./TranscriptionM
  * @returns {Promise<string>} A promise that resolves to the transcribed text.
  */
 export declare function generateTranscription<DATA>(model: TranscriptionModel<DATA, TranscriptionModelSettings>, data: DATA, options?: FunctionOptions & {
-    returnType?: "text";
+    fullResponse?: false;
 }): Promise<string>;
 export declare function generateTranscription<DATA>(model: TranscriptionModel<DATA, TranscriptionModelSettings>, data: DATA, options: FunctionOptions & {
-    returnType: "full";
+    fullResponse: true;
 }): Promise<{
     value: string;
     response: unknown;

package/model-function/generate-transcription/generateTranscription.js

@@ -13,5 +13,5 @@ export async function generateTranscription(model, data, options) {
             };
         },
     });
-    return options?.returnType === "full" ? fullResponse : fullResponse.value;
+    return options?.fullResponse ? fullResponse : fullResponse.value;
 }