modelfusion 0.53.1 → 0.54.0

package/README.md

@@ -623,9 +623,9 @@ Create an 19th century painting image for your input.
 
 Record audio with push-to-talk and transcribe it using Whisper, implemented as a Next.js app. The app shows a list of the transcriptions.
 
-### [Speech Streaming (Vite(React) + Fastify))](https://github.com/lgrammel/modelfusion/tree/main/examples/speech-streaming-vite-react-fastify)
+### [Duplex Speech Streaming (using Vite/React & ModelFusion Server/Fastify)](https://github.com/lgrammel/modelfusion/tree/main/examples/speech-streaming-vite-react-fastify)
 
-> _Speech Streaming_, _OpenAI_, _Elevenlabs_ _streaming_, _Vite_, _Fastify_
+> _Speech Streaming_, _OpenAI_, _Elevenlabs_ _streaming_, _Vite_, _Fastify_, _ModelFusion Server_
 
 Given a prompt, the server returns both a text and a speech stream response.
 

package/browser/convertAudioChunksToBase64.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertAudioChunksToBase64 = void 0;
+const convertBlobToBase64_js_1 = require("./convertBlobToBase64.cjs");
+function convertAudioChunksToBase64({ audioChunks, mimeType, }) {
+    return (0, convertBlobToBase64_js_1.convertBlobToBase64)(new Blob(audioChunks, { type: mimeType }));
+}
+exports.convertAudioChunksToBase64 = convertAudioChunksToBase64;

package/browser/convertAudioChunksToBase64.d.ts

@@ -0,0 +1,4 @@
+export declare function convertAudioChunksToBase64({ audioChunks, mimeType, }: {
+    audioChunks: Blob[];
+    mimeType: string;
+}): Promise<string>;

package/browser/convertAudioChunksToBase64.js

@@ -0,0 +1,4 @@
+import { convertBlobToBase64 } from "./convertBlobToBase64.js";
+export function convertAudioChunksToBase64({ audioChunks, mimeType, }) {
+    return convertBlobToBase64(new Blob(audioChunks, { type: mimeType }));
+}

package/browser/convertBlobToBase64.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertBlobToBase64 = void 0;
+async function convertBlobToBase64(blob) {
+    return new Promise((resolve, reject) => {
+        const reader = new FileReader();
+        reader.onloadend = () => {
+            if (reader.result) {
+                const base64String = btoa(new Uint8Array(reader.result).reduce((data, byte) => data + String.fromCharCode(byte), ""));
+                resolve(base64String);
+            }
+            else {
+                reject(new Error("Failed to read blob."));
+            }
+        };
+        reader.onerror = () => {
+            reader.abort();
+            reject(new DOMException("Problem parsing input blob."));
+        };
+        reader.readAsArrayBuffer(blob);
+    });
+}
+exports.convertBlobToBase64 = convertBlobToBase64;

package/browser/convertBlobToBase64.d.ts

@@ -0,0 +1 @@
+export declare function convertBlobToBase64(blob: Blob): Promise<string>;

package/browser/convertBlobToBase64.js

@@ -0,0 +1,19 @@
+export async function convertBlobToBase64(blob) {
+    return new Promise((resolve, reject) => {
+        const reader = new FileReader();
+        reader.onloadend = () => {
+            if (reader.result) {
+                const base64String = btoa(new Uint8Array(reader.result).reduce((data, byte) => data + String.fromCharCode(byte), ""));
+                resolve(base64String);
+            }
+            else {
+                reject(new Error("Failed to read blob."));
+            }
+        };
+        reader.onerror = () => {
+            reader.abort();
+            reject(new DOMException("Problem parsing input blob."));
+        };
+        reader.readAsArrayBuffer(blob);
+    });
+}

package/{ui → browser}/index.cjs

@@ -15,3 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./MediaSourceAppender.cjs"), exports);
+__exportStar(require("./convertAudioChunksToBase64.cjs"), exports);
+__exportStar(require("./convertBlobToBase64.cjs"), exports);
+__exportStar(require("./invokeFlow.cjs"), exports);
+__exportStar(require("./readEventSource.cjs"), exports);
+__exportStar(require("./readEventSourceStream.cjs"), exports);

package/browser/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./MediaSourceAppender.js";
+export * from "./convertAudioChunksToBase64.js";
+export * from "./convertBlobToBase64.js";
+export * from "./invokeFlow.js";
+export * from "./readEventSource.js";
+export * from "./readEventSourceStream.js";

package/browser/index.js

@@ -0,0 +1,6 @@
+export * from "./MediaSourceAppender.js";
+export * from "./convertAudioChunksToBase64.js";
+export * from "./convertBlobToBase64.js";
+export * from "./invokeFlow.js";
+export * from "./readEventSource.js";
+export * from "./readEventSourceStream.js";

package/browser/invokeFlow.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeFlow = void 0;
+const ZodSchema_1 = require("../core/structure/ZodSchema");
+const readEventSource_1 = require("./readEventSource");
+async function invokeFlow({ url, input, schema, onEvent, onStop, }) {
+    const response = await fetch(url, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(input),
+    });
+    const eventSourceUrl = (await response.json()).url;
+    (0, readEventSource_1.readEventSource)({
+        url: eventSourceUrl,
+        schema: new ZodSchema_1.ZodSchema(schema.events),
+        isStopEvent(event) {
+            return event.data === "[DONE]";
+        },
+        onEvent,
+        onStop,
+    });
+}
+exports.invokeFlow = invokeFlow;

package/browser/invokeFlow.d.ts

@@ -0,0 +1,8 @@
+import { FlowSchema } from "../server/fastify/FlowSchema";
+export declare function invokeFlow<INPUT, EVENT>({ url, input, schema, onEvent, onStop, }: {
+    url: string;
+    input: INPUT;
+    schema: FlowSchema<INPUT, EVENT>;
+    onEvent: (event: EVENT, eventSource: EventSource) => void;
+    onStop?: (eventSource: EventSource) => void;
+}): Promise<void>;

package/browser/invokeFlow.js

@@ -0,0 +1,19 @@
+import { ZodSchema } from "../core/structure/ZodSchema";
+import { readEventSource } from "./readEventSource";
+export async function invokeFlow({ url, input, schema, onEvent, onStop, }) {
+    const response = await fetch(url, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(input),
+    });
+    const eventSourceUrl = (await response.json()).url;
+    readEventSource({
+        url: eventSourceUrl,
+        schema: new ZodSchema(schema.events),
+        isStopEvent(event) {
+            return event.data === "[DONE]";
+        },
+        onEvent,
+        onStop,
+    });
+}

package/{event-source → browser}/readEventSource.cjs

@@ -2,11 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readEventSource = void 0;
 const parseJSON_js_1 = require("../util/parseJSON.cjs");
-function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+function readEventSource({ url, schema, onEvent, onError = console.error, onStop, isStopEvent, }) {
     const eventSource = new EventSource(url);
-    eventSource.onmessage = (e) => {
+    eventSource.onmessage = (event) => {
         try {
-            const parseResult = (0, parseJSON_js_1.safeParseJsonWithSchema)(e.data, schema);
+            if (isStopEvent?.(event)) {
+                eventSource.close();
+                onStop?.(eventSource);
+                return;
+            }
+            const parseResult = (0, parseJSON_js_1.safeParseJsonWithSchema)(event.data, schema);
             if (!parseResult.success) {
                 onError(parseResult.error, eventSource);
                 return;

package/{event-source → browser}/readEventSource.d.ts

@@ -1,7 +1,9 @@
 import { Schema } from "../core/structure/Schema.js";
-export declare function readEventSource<T>({ url, schema, onEvent, onError, }: {
+export declare function readEventSource<T>({ url, schema, onEvent, onError, onStop, isStopEvent, }: {
     url: string;
     schema: Schema<T>;
     onEvent: (event: T, eventSource: EventSource) => void;
     onError?: (error: unknown, eventSource: EventSource) => void;
+    onStop?: (eventSource: EventSource) => void;
+    isStopEvent?: (event: MessageEvent<unknown>) => boolean;
 }): void;

package/{event-source → browser}/readEventSource.js

@@ -1,9 +1,14 @@
 import { safeParseJsonWithSchema } from "../util/parseJSON.js";
-export function readEventSource({ url, schema, onEvent, onError = console.error, }) {
+export function readEventSource({ url, schema, onEvent, onError = console.error, onStop, isStopEvent, }) {
     const eventSource = new EventSource(url);
-    eventSource.onmessage = (e) => {
+    eventSource.onmessage = (event) => {
         try {
-            const parseResult = safeParseJsonWithSchema(e.data, schema);
+            if (isStopEvent?.(event)) {
+                eventSource.close();
+                onStop?.(eventSource);
+                return;
+            }
+            const parseResult = safeParseJsonWithSchema(event.data, schema);
             if (!parseResult.success) {
                 onError(parseResult.error, eventSource);
                 return;

package/{event-source → browser}/readEventSourceStream.cjs

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readEventSourceStream = void 0;
 const parseJSON_js_1 = require("../util/parseJSON.cjs");
 const AsyncQueue_js_1 = require("../util/AsyncQueue.cjs");
-const parseEventSourceStream_js_1 = require("./parseEventSourceStream.cjs");
+const parseEventSourceStream_js_1 = require("../event-source/parseEventSourceStream.cjs");
 function readEventSourceStream({ stream, schema, errorHandler, }) {
     const queue = new AsyncQueue_js_1.AsyncQueue();
     // run async (no await on purpose):

package/{event-source → browser}/readEventSourceStream.js

@@ -1,6 +1,6 @@
 import { safeParseJsonWithSchema } from "../util/parseJSON.js";
 import { AsyncQueue } from "../util/AsyncQueue.js";
-import { parseEventSourceStream } from "./parseEventSourceStream.js";
+import { parseEventSourceStream } from "../event-source/parseEventSourceStream.js";
 export function readEventSourceStream({ stream, schema, errorHandler, }) {
     const queue = new AsyncQueue();
     // run async (no await on purpose):

package/core/FunctionOptions.d.ts

@@ -5,7 +5,7 @@ import { FunctionObserver } from "./FunctionObserver.js";
  */
 export type FunctionOptions = {
     /**
-     * Optional function identifier that is used in events to identify the function.
+     * Optional function identifier. Used in events and logging.
      */
     functionId?: string;
     /**
@@ -18,11 +18,12 @@ export type FunctionOptions = {
      */
     observers?: Array<FunctionObserver>;
     /**
-     * Optional run as part of which this function is called.
+     * Optional run as part of which this function is called. Used in events and logging.
+     * Run callbacks are invoked when it is provided.
      */
     run?: Run;
     /**
-     * Unique identifier of the call id of the parent function.
+     * Unique identifier of the call id of the parent function. Used in events and logging.
      */
     parentCallId?: string | undefined;
 };

package/event-source/createEventSourceStream.cjs

@@ -5,10 +5,14 @@ const textEncoder = new TextEncoder();
 function createEventSourceStream(events) {
     return new ReadableStream({
         async start(controller) {
-            for await (const event of events) {
-                controller.enqueue(textEncoder.encode(`data: ${JSON.stringify(event)}\n\n`));
+            try {
+                for await (const event of events) {
+                    controller.enqueue(textEncoder.encode(`data: ${JSON.stringify(event)}\n\n`));
+                }
+            }
+            finally {
+                controller.close();
             }
-            controller.close();
         },
     });
 }

package/event-source/createEventSourceStream.js

@@ -2,10 +2,14 @@ const textEncoder = new TextEncoder();
 export function createEventSourceStream(events) {
     return new ReadableStream({
         async start(controller) {
-            for await (const event of events) {
-                controller.enqueue(textEncoder.encode(`data: ${JSON.stringify(event)}\n\n`));
+            try {
+                for await (const event of events) {
+                    controller.enqueue(textEncoder.encode(`data: ${JSON.stringify(event)}\n\n`));
+                }
+            }
+            finally {
+                controller.close();
             }
-            controller.close();
         },
     });
 }

package/event-source/index.cjs

@@ -15,5 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./createEventSourceStream.cjs"), exports);
-__exportStar(require("./readEventSource.cjs"), exports);
-__exportStar(require("./readEventSourceStream.cjs"), exports);

package/event-source/index.d.ts

@@ -1,3 +1 @@
 export * from "./createEventSourceStream.js";
-export * from "./readEventSource.js";
-export * from "./readEventSourceStream.js";

package/event-source/index.js

@@ -1,3 +1 @@
 export * from "./createEventSourceStream.js";
-export * from "./readEventSource.js";
-export * from "./readEventSourceStream.js";

package/index.cjs

@@ -25,6 +25,5 @@ __exportStar(require("./observability/index.cjs"), exports);
 __exportStar(require("./retriever/index.cjs"), exports);
 __exportStar(require("./text-chunk/index.cjs"), exports);
 __exportStar(require("./tool/index.cjs"), exports);
-__exportStar(require("./ui/index.cjs"), exports);
 __exportStar(require("./util/index.cjs"), exports);
 __exportStar(require("./vector-index/index.cjs"), exports);

package/index.d.ts

@@ -9,6 +9,5 @@ export * from "./observability/index.js";
 export * from "./retriever/index.js";
 export * from "./text-chunk/index.js";
 export * from "./tool/index.js";
-export * from "./ui/index.js";
 export * from "./util/index.js";
 export * from "./vector-index/index.js";

package/index.js

@@ -9,6 +9,5 @@ export * from "./observability/index.js";
 export * from "./retriever/index.js";
 export * from "./text-chunk/index.js";
 export * from "./tool/index.js";
-export * from "./ui/index.js";
 export * from "./util/index.js";
 export * from "./vector-index/index.js";

package/model-function/embed/embed.cjs

@@ -6,6 +6,8 @@ const ModelFunctionPromise_js_1 = require("../ModelFunctionPromise.cjs");
 /**
  * Generate embeddings for multiple values.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel(...),
@@ -14,6 +16,12 @@ const ModelFunctionPromise_js_1 = require("../ModelFunctionPromise.cjs");
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating embeddings.
+ * @param {VALUE[]} values - The values to generate embeddings for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<Vector[]>} - A promise that resolves to an array of vectors representing the embeddings.
  */
 function embedMany(model, values, options) {
     return new ModelFunctionPromise_js_1.ModelFunctionPromise((0, executeStandardCall_js_1.executeStandardCall)({
@@ -50,11 +58,19 @@ exports.embedMany = embedMany;
 /**
  * Generate an embedding for a single value.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embedding = await embed(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating the embedding.
+ * @param {VALUE} value - The value to generate an embedding for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<Vector>} - A promise that resolves to a vector representing the embedding.
  */
 function embed(model, value, options) {
     return new ModelFunctionPromise_js_1.ModelFunctionPromise((0, executeStandardCall_js_1.executeStandardCall)({

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

@@ -5,6 +5,8 @@ import { EmbeddingModel, EmbeddingModelSettings } from "./EmbeddingModel.js";
 /**
  * Generate embeddings for multiple values.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel(...),
@@ -13,15 +15,29 @@ import { EmbeddingModel, EmbeddingModelSettings } from "./EmbeddingModel.js";
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating embeddings.
+ * @param {VALUE[]} values - The values to generate embeddings for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<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): ModelFunctionPromise<Vector[]>;
 /**
  * Generate an embedding for a single value.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embedding = await embed(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating the embedding.
+ * @param {VALUE} value - The value to generate an embedding for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<Vector>} - A promise that resolves to a vector representing the embedding.
  */
 export declare function embed<VALUE>(model: EmbeddingModel<VALUE, EmbeddingModelSettings>, value: VALUE, options?: FunctionOptions): ModelFunctionPromise<Vector>;

package/model-function/embed/embed.js

@@ -3,6 +3,8 @@ import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 /**
  * Generate embeddings for multiple values.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embeddings = await embedMany(
  *   new OpenAITextEmbeddingModel(...),
@@ -11,6 +13,12 @@ import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating embeddings.
+ * @param {VALUE[]} values - The values to generate embeddings for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<Vector[]>} - A promise that resolves to an array of vectors representing the embeddings.
  */
 export function embedMany(model, values, options) {
     return new ModelFunctionPromise(executeStandardCall({
@@ -46,11 +54,19 @@ export function embedMany(model, values, options) {
 /**
  * Generate an embedding for a single value.
  *
+ * @see https://modelfusion.dev/guide/function/embed
+ *
  * @example
  * const embedding = await embed(
  *   new OpenAITextEmbeddingModel(...),
  *   "At first, Nox didn't know what to do with the pup."
  * );
+ *
+ * @param {EmbeddingModel<VALUE, EmbeddingModelSettings>} model - The model to use for generating the embedding.
+ * @param {VALUE} value - The value to generate an embedding for.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ModelFunctionPromise<Vector>} - A promise that resolves to a vector representing the embedding.
  */
 export function embed(model, value, options) {
     return new ModelFunctionPromise(executeStandardCall({

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

@@ -4,11 +4,13 @@ exports.generateImage = void 0;
 const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
 const ImageGenerationPromise_js_1 = require("./ImageGenerationPromise.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,
+ * Generates an image using a prompt.
+ *
+ * The prompt 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.
  *
+ * @see https://modelfusion.dev/guide/function/generate-image
+ *
  * @example
  * const image = await generateImage(
  *   new StabilityImageGenerationModel(...),
@@ -17,6 +19,13 @@ const ImageGenerationPromise_js_1 = require("./ImageGenerationPromise.cjs");
  *     { text: "style of early 19th century painting", weight: 0.5 },
  *   ]
  * );
+ *
+ * @param {ImageGenerationModel<PROMPT, ImageGenerationModelSettings>} model - The image generation model to be used.
+ * @param {PROMPT} prompt - The prompt to be used for image generation.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ImageGenerationPromise} - Returns a promise that resolves to the generated image.
+ * The image is a Buffer containing the image data in PNG format.
  */
 function generateImage(model, prompt, options) {
     return new ImageGenerationPromise_js_1.ImageGenerationPromise((0, executeStandardCall_js_1.executeStandardCall)({

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

@@ -2,11 +2,13 @@ import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { ImageGenerationModel, ImageGenerationModelSettings } from "./ImageGenerationModel.js";
 import { ImageGenerationPromise } from "./ImageGenerationPromise.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,
+ * Generates an image using a prompt.
+ *
+ * The prompt 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.
  *
+ * @see https://modelfusion.dev/guide/function/generate-image
+ *
  * @example
  * const image = await generateImage(
  *   new StabilityImageGenerationModel(...),
@@ -15,5 +17,12 @@ import { ImageGenerationPromise } from "./ImageGenerationPromise.js";
  *     { text: "style of early 19th century painting", weight: 0.5 },
  *   ]
  * );
+ *
+ * @param {ImageGenerationModel<PROMPT, ImageGenerationModelSettings>} model - The image generation model to be used.
+ * @param {PROMPT} prompt - The prompt to be used for image generation.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ImageGenerationPromise} - Returns a promise that resolves to the generated image.
+ * 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): ImageGenerationPromise;

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

@@ -1,11 +1,13 @@
 import { executeStandardCall } from "../executeStandardCall.js";
 import { ImageGenerationPromise } from "./ImageGenerationPromise.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,
+ * Generates an image using a prompt.
+ *
+ * The prompt 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.
  *
+ * @see https://modelfusion.dev/guide/function/generate-image
+ *
  * @example
  * const image = await generateImage(
  *   new StabilityImageGenerationModel(...),
@@ -14,6 +16,13 @@ import { ImageGenerationPromise } from "./ImageGenerationPromise.js";
  *     { text: "style of early 19th century painting", weight: 0.5 },
  *   ]
  * );
+ *
+ * @param {ImageGenerationModel<PROMPT, ImageGenerationModelSettings>} model - The image generation model to be used.
+ * @param {PROMPT} prompt - The prompt to be used for image generation.
+ * @param {FunctionOptions} [options] - Optional settings for the function.
+ *
+ * @returns {ImageGenerationPromise} - Returns a promise that resolves to the generated image.
+ * The image is a Buffer containing the image data in PNG format.
  */
 export function generateImage(model, prompt, options) {
     return new ImageGenerationPromise(executeStandardCall({

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

@@ -4,7 +4,22 @@ exports.generateSpeech = void 0;
 const ModelFunctionPromise_js_1 = require("../ModelFunctionPromise.cjs");
 const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
 /**
- * Synthesizes speech from text.
+ * Synthesizes speech from text. Also called text-to-speech (TTS).
+ *
+ * @see https://modelfusion.dev/guide/function/generate-speech
+ *
+ * @example
+ * const speech = await generateSpeech(
+ *   new LmntSpeechModel(...),
+ *   "Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
+ *    "as The Rolling Stones unveil 'Hackney Diamonds.'
+ * );
+ *
+ * @param {SpeechGenerationModel<SpeechGenerationModelSettings>} model - The speech generation model.
+ * @param {string} text - The text to be converted to speech.
+ * @param {FunctionOptions} [options] - Optional function options.
+ *
+ * @returns {ModelFunctionPromise<Buffer>} - A promise that resolves to a buffer containing the synthesized speech.
  */
 function generateSpeech(model, text, options) {
     return new ModelFunctionPromise_js_1.ModelFunctionPromise((0, executeStandardCall_js_1.executeStandardCall)({

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

@@ -3,6 +3,21 @@ import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { SpeechGenerationModel, SpeechGenerationModelSettings } from "./SpeechGenerationModel.js";
 /**
- * Synthesizes speech from text.
+ * Synthesizes speech from text. Also called text-to-speech (TTS).
+ *
+ * @see https://modelfusion.dev/guide/function/generate-speech
+ *
+ * @example
+ * const speech = await generateSpeech(
+ *   new LmntSpeechModel(...),
+ *   "Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
+ *    "as The Rolling Stones unveil 'Hackney Diamonds.'
+ * );
+ *
+ * @param {SpeechGenerationModel<SpeechGenerationModelSettings>} model - The speech generation model.
+ * @param {string} text - The text to be converted to speech.
+ * @param {FunctionOptions} [options] - Optional function options.
+ *
+ * @returns {ModelFunctionPromise<Buffer>} - A promise that resolves to a buffer containing the synthesized speech.
  */
 export declare function generateSpeech(model: SpeechGenerationModel<SpeechGenerationModelSettings>, text: string, options?: FunctionOptions): ModelFunctionPromise<Buffer>;

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

@@ -1,7 +1,22 @@
 import { ModelFunctionPromise } from "../ModelFunctionPromise.js";
 import { executeStandardCall } from "../executeStandardCall.js";
 /**
- * Synthesizes speech from text.
+ * Synthesizes speech from text. Also called text-to-speech (TTS).
+ *
+ * @see https://modelfusion.dev/guide/function/generate-speech
+ *
+ * @example
+ * const speech = await generateSpeech(
+ *   new LmntSpeechModel(...),
+ *   "Good evening, ladies and gentlemen! Exciting news on the airwaves tonight " +
+ *    "as The Rolling Stones unveil 'Hackney Diamonds.'
+ * );
+ *
+ * @param {SpeechGenerationModel<SpeechGenerationModelSettings>} model - The speech generation model.
+ * @param {string} text - The text to be converted to speech.
+ * @param {FunctionOptions} [options] - Optional function options.
+ *
+ * @returns {ModelFunctionPromise<Buffer>} - A promise that resolves to a buffer containing the synthesized speech.
  */
 export function generateSpeech(model, text, options) {
     return new ModelFunctionPromise(executeStandardCall({