modelfusion 0.6.0 → 0.8.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 I am still exploring the API design. Feedback and suggestions are welcome.
 
 ## 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,15 +103,26 @@ 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(
+// access the full response and the metadata:
+// the response type is specific to the model that's being used
+const { response, metadata } = await generateText(
   new OpenAITextGenerationModel({
     model: "text-davinci-003",
+    maxTokens: 1000,
+    n: 2, // generate 2 completions
   }),
-  "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 }
 );
+
+for (const choice of response.choices) {
+  console.log(choice.text);
+}
+
+console.log(`Duration: ${metadata.durationInMs}ms`);
 ```
 
 ### [Generate JSON](https://modelfusion.dev/guide/function/generate-json)
@@ -120,7 +130,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 +259,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 +273,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 +284,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 +409,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
 
@@ -436,9 +447,9 @@ Record audio with push-to-talk and transcribe it using Whisper, implemented as a
 
 ### [BabyAGI Agent](https://github.com/lgrammel/modelfusion/tree/main/examples/babyagi-agent)
 
-> _terminal app_, _agent_, _BabyAGI_, _OpenAI text-davinci-003_
+> _terminal app_, _agent_, _BabyAGI_
 
-TypeScript implementation of the classic [BabyAGI](https://github.com/yoheinakajima/babyagi/blob/main/classic/babyagi.py) by [@yoheinakajima](https://twitter.com/yoheinakajima) without embeddings.
+TypeScript implementation of the BabyAGI classic and BabyBeeAGI.
 
 ### [Middle school math agent](https://github.com/lgrammel/modelfusion/tree/main/examples/middle-school-math-agent)
 

package/composed-function/index.cjs

@@ -14,9 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./use-tool/NoSuchToolError.cjs"), exports);
-__exportStar(require("./use-tool/Tool.cjs"), exports);
-__exportStar(require("./use-tool/useTool.cjs"), exports);
 __exportStar(require("./summarize/SummarizationFunction.cjs"), exports);
 __exportStar(require("./summarize/summarizeRecursively.cjs"), exports);
 __exportStar(require("./summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.cjs"), exports);

package/composed-function/index.d.ts

@@ -1,6 +1,3 @@
-export * from "./use-tool/NoSuchToolError.js";
-export * from "./use-tool/Tool.js";
-export * from "./use-tool/useTool.js";
 export * from "./summarize/SummarizationFunction.js";
 export * from "./summarize/summarizeRecursively.js";
 export * from "./summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.js";

package/composed-function/index.js

@@ -1,6 +1,3 @@
-export * from "./use-tool/NoSuchToolError.js";
-export * from "./use-tool/Tool.js";
-export * from "./use-tool/useTool.js";
 export * from "./summarize/SummarizationFunction.js";
 export * from "./summarize/summarizeRecursively.js";
 export * from "./summarize/summarizeRecursivelyWithTextGenerationAndTokenSplitting.js";

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/index.cjs

@@ -21,5 +21,6 @@ __exportStar(require("./model-provider/index.cjs"), exports);
 __exportStar(require("./prompt/index.cjs"), exports);
 __exportStar(require("./run/index.cjs"), exports);
 __exportStar(require("./text-chunk/index.cjs"), exports);
+__exportStar(require("./tool/index.cjs"), exports);
 __exportStar(require("./util/index.cjs"), exports);
 __exportStar(require("./vector-index/index.cjs"), exports);

package/index.d.ts

@@ -5,5 +5,6 @@ export * from "./model-provider/index.js";
 export * from "./prompt/index.js";
 export * from "./run/index.js";
 export * from "./text-chunk/index.js";
+export * from "./tool/index.js";
 export * from "./util/index.js";
 export * from "./vector-index/index.js";

package/index.js

@@ -5,5 +5,6 @@ export * from "./model-provider/index.js";
 export * from "./prompt/index.js";
 export * from "./run/index.js";
 export * from "./text-chunk/index.js";
+export * from "./tool/index.js";
 export * from "./util/index.js";
 export * from "./vector-index/index.js";

package/model-function/Model.d.ts

@@ -1,7 +1,7 @@
 import { ModelInformation } from "./ModelInformation.js";
-import { ModelCallObserver } from "./ModelCallObserver.js";
+import { RunFunctionObserver } from "../run/RunFunctionObserver.js";
 export interface ModelSettings {
-    observers?: Array<ModelCallObserver>;
+    observers?: Array<RunFunctionObserver>;
 }
 export interface Model<SETTINGS> {
     modelInformation: ModelInformation;

package/model-function/ModelCallEvent.d.ts

@@ -1,4 +1,4 @@
-import { IdMetadata } from "../run/IdMetadata.js";
+import { RunFunctionFinishedEventMetadata, RunFunctionStartedEventMetadata } from "../run/RunFunctionEvent.js";
 import { ModelInformation } from "./ModelInformation.js";
 import { TextEmbeddingFinishedEvent, TextEmbeddingStartedEvent } from "./embed-text/TextEmbeddingEvent.js";
 import { ImageGenerationFinishedEvent, ImageGenerationStartedEvent } from "./generate-image/ImageGenerationEvent.js";
@@ -6,13 +6,11 @@ import { JsonGenerationFinishedEvent, JsonGenerationStartedEvent } from "./gener
 import { TextGenerationFinishedEvent, TextGenerationStartedEvent } from "./generate-text/TextGenerationEvent.js";
 import { TextStreamingFinishedEvent, TextStreamingStartedEvent } from "./generate-text/TextStreamingEvent.js";
 import { TranscriptionFinishedEvent, TranscriptionStartedEvent } from "./transcribe-audio/TranscriptionEvent.js";
-export type ModelCallEvent = ModelCallStartedEvent | ModelCallFinishedEvent;
-export type ModelCallStartedEventMetadata = IdMetadata & {
+export type ModelCallStartedEventMetadata = RunFunctionStartedEventMetadata & {
     model: ModelInformation;
-    startEpochSeconds: number;
 };
 export type ModelCallStartedEvent = ImageGenerationStartedEvent | JsonGenerationStartedEvent | TextEmbeddingStartedEvent | TextGenerationStartedEvent | TextStreamingStartedEvent | TranscriptionStartedEvent;
-export type ModelCallFinishedEventMetadata = ModelCallStartedEventMetadata & {
-    durationInMs: number;
+export type ModelCallFinishedEventMetadata = RunFunctionFinishedEventMetadata & {
+    model: ModelInformation;
 };
 export type ModelCallFinishedEvent = ImageGenerationFinishedEvent | JsonGenerationFinishedEvent | TextEmbeddingFinishedEvent | TextGenerationFinishedEvent | TextStreamingFinishedEvent | TranscriptionFinishedEvent;

package/model-function/SuccessfulModelCall.cjs

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractSuccessfulModelCalls = void 0;
-function extractSuccessfulModelCalls(modelCallEvents) {
-    return modelCallEvents
-        .filter((event) => "status" in event && event.status === "success")
+function extractSuccessfulModelCalls(runFunctionEvents) {
+    return runFunctionEvents
+        .filter((event) => Object.keys(eventTypeToCostType).includes(event.type) &&
+        "status" in event &&
+        event.status === "success")
         .map((event) => ({
         model: event.metadata.model,
         settings: event.settings,
@@ -15,6 +17,7 @@ exports.extractSuccessfulModelCalls = extractSuccessfulModelCalls;
 const eventTypeToCostType = {
     "image-generation-finished": "image-generation",
     "json-generation-finished": "json-generation",
+    "json-or-text-generation-finished": "json-or-text-generation",
     "text-embedding-finished": "text-embedding",
     "text-generation-finished": "text-generation",
     "text-streaming-finished": "text-streaming",

package/model-function/SuccessfulModelCall.d.ts

@@ -1,9 +1,9 @@
-import { ModelCallFinishedEvent, ModelCallStartedEvent } from "./ModelCallEvent.js";
+import { RunFunctionEvent } from "../run/RunFunctionEvent.js";
 import { ModelInformation } from "./ModelInformation.js";
 export type SuccessfulModelCall = {
-    type: "image-generation" | "json-generation" | "text-embedding" | "text-generation" | "text-streaming" | "transcription";
+    type: "image-generation" | "json-generation" | "json-or-text-generation" | "text-embedding" | "text-generation" | "text-streaming" | "transcription";
     model: ModelInformation;
     settings: unknown;
     response: unknown;
 };
-export declare function extractSuccessfulModelCalls(modelCallEvents: (ModelCallFinishedEvent | ModelCallStartedEvent)[]): SuccessfulModelCall[];
+export declare function extractSuccessfulModelCalls(runFunctionEvents: RunFunctionEvent[]): SuccessfulModelCall[];

package/model-function/SuccessfulModelCall.js

@@ -1,6 +1,8 @@
-export function extractSuccessfulModelCalls(modelCallEvents) {
-    return modelCallEvents
-        .filter((event) => "status" in event && event.status === "success")
+export function extractSuccessfulModelCalls(runFunctionEvents) {
+    return runFunctionEvents
+        .filter((event) => Object.keys(eventTypeToCostType).includes(event.type) &&
+        "status" in event &&
+        event.status === "success")
         .map((event) => ({
         model: event.metadata.model,
         settings: event.settings,
@@ -11,6 +13,7 @@ export function extractSuccessfulModelCalls(modelCallEvents) {
 const eventTypeToCostType = {
     "image-generation-finished": "image-generation",
     "json-generation-finished": "json-generation",
+    "json-or-text-generation-finished": "json-or-text-generation",
     "text-embedding-finished": "text-embedding",
     "text-generation-finished": "text-generation",
     "text-streaming-finished": "text-streaming",

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/executeCall.cjs

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCall = void 0;
 const nanoid_1 = require("nanoid");
+const RunFunctionEventSource_js_1 = require("../run/RunFunctionEventSource.cjs");
 const DurationMeasurement_js_1 = require("../util/DurationMeasurement.cjs");
 const AbortError_js_1 = require("../util/api/AbortError.cjs");
 const runSafe_js_1 = require("../util/runSafe.cjs");
-const ModelCallEventSource_js_1 = require("./ModelCallEventSource.cjs");
 async function executeCall({ model, options, getStartEvent, getAbortEvent, getFailureEvent, getSuccessEvent, generateResponse, extractOutputValue, }) {
     if (options?.settings != null) {
         model = model.withSettings(options.settings);
@@ -16,7 +16,7 @@ async function executeCall({ model, options, getStartEvent, getAbortEvent, getFa
     }
     const run = options?.run;
     const settings = model.settings;
-    const eventSource = new ModelCallEventSource_js_1.ModelCallEventSource({
+    const eventSource = new RunFunctionEventSource_js_1.RunFunctionEventSource({
         observers: [...(settings.observers ?? []), ...(run?.observers ?? [])],
         errorHandler: run?.errorHandler,
     });
@@ -30,7 +30,7 @@ async function executeCall({ model, options, getStartEvent, getAbortEvent, getFa
         model: model.modelInformation,
         startEpochSeconds: durationMeasurement.startEpochSeconds,
     };
-    eventSource.notifyModelCallStarted(getStartEvent(startMetadata, settings));
+    eventSource.notifyRunFunctionStarted(getStartEvent(startMetadata, settings));
     const result = await (0, runSafe_js_1.runSafe)(() => generateResponse({
         functionId: options?.functionId,
         settings,
@@ -42,15 +42,15 @@ async function executeCall({ model, options, getStartEvent, getAbortEvent, getFa
     };
     if (!result.ok) {
         if (result.isAborted) {
-            eventSource.notifyModelCallFinished(getAbortEvent(finishMetadata, settings));
+            eventSource.notifyRunFunctionFinished(getAbortEvent(finishMetadata, settings));
             throw new AbortError_js_1.AbortError();
         }
-        eventSource.notifyModelCallFinished(getFailureEvent(finishMetadata, settings, result.error));
+        eventSource.notifyRunFunctionFinished(getFailureEvent(finishMetadata, settings, result.error));
         throw result.error;
     }
     const response = result.output;
     const output = extractOutputValue(response);
-    eventSource.notifyModelCallFinished(getSuccessEvent(finishMetadata, settings, response, output));
+    eventSource.notifyRunFunctionFinished(getSuccessEvent(finishMetadata, settings, response, output));
     return {
         output,
         response,

package/model-function/executeCall.js

@@ -1,8 +1,8 @@
 import { nanoid as createId } from "nanoid";
+import { RunFunctionEventSource } from "../run/RunFunctionEventSource.js";
 import { startDurationMeasurement } from "../util/DurationMeasurement.js";
 import { AbortError } from "../util/api/AbortError.js";
 import { runSafe } from "../util/runSafe.js";
-import { ModelCallEventSource } from "./ModelCallEventSource.js";
 export async function executeCall({ model, options, getStartEvent, getAbortEvent, getFailureEvent, getSuccessEvent, generateResponse, extractOutputValue, }) {
     if (options?.settings != null) {
         model = model.withSettings(options.settings);
@@ -13,7 +13,7 @@ export async function executeCall({ model, options, getStartEvent, getAbortEvent
     }
     const run = options?.run;
     const settings = model.settings;
-    const eventSource = new ModelCallEventSource({
+    const eventSource = new RunFunctionEventSource({
         observers: [...(settings.observers ?? []), ...(run?.observers ?? [])],
         errorHandler: run?.errorHandler,
     });
@@ -27,7 +27,7 @@ export async function executeCall({ model, options, getStartEvent, getAbortEvent
         model: model.modelInformation,
         startEpochSeconds: durationMeasurement.startEpochSeconds,
     };
-    eventSource.notifyModelCallStarted(getStartEvent(startMetadata, settings));
+    eventSource.notifyRunFunctionStarted(getStartEvent(startMetadata, settings));
     const result = await runSafe(() => generateResponse({
         functionId: options?.functionId,
         settings,
@@ -39,15 +39,15 @@ export async function executeCall({ model, options, getStartEvent, getAbortEvent
     };
     if (!result.ok) {
         if (result.isAborted) {
-            eventSource.notifyModelCallFinished(getAbortEvent(finishMetadata, settings));
+            eventSource.notifyRunFunctionFinished(getAbortEvent(finishMetadata, settings));
             throw new AbortError();
         }
-        eventSource.notifyModelCallFinished(getFailureEvent(finishMetadata, settings, result.error));
+        eventSource.notifyRunFunctionFinished(getFailureEvent(finishMetadata, settings, result.error));
         throw result.error;
     }
     const response = result.output;
     const output = extractOutputValue(response);
-    eventSource.notifyModelCallFinished(getSuccessEvent(finishMetadata, settings, response, output));
+    eventSource.notifyRunFunctionFinished(getSuccessEvent(finishMetadata, settings, response, output));
     return {
         output,
         response,

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>;