modelfusion 0.6.0 → 0.8.0

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/JsonGenerationEvent.d.ts

@@ -1,12 +1,12 @@
 import { ModelCallFinishedEventMetadata, ModelCallStartedEventMetadata } from "../ModelCallEvent.js";
 export type JsonGenerationStartedEvent = {
-    type: "json-generation-started";
+    type: "json-generation-started" | "json-or-text-generation-started";
     metadata: ModelCallStartedEventMetadata;
     settings: unknown;
     prompt: unknown;
 };
 export type JsonGenerationFinishedEvent = {
-    type: "json-generation-finished";
+    type: "json-generation-finished" | "json-or-text-generation-finished";
     metadata: ModelCallFinishedEventMetadata;
     settings: unknown;
     prompt: unknown;

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

@@ -35,20 +35,20 @@ async function generateJsonOrText(model, schemaDefinitions, prompt, options) {
             };
         },
         getStartEvent: (metadata, settings) => ({
-            type: "json-generation-started",
+            type: "json-or-text-generation-started",
             metadata,
             settings,
             prompt,
         }),
         getAbortEvent: (metadata, settings) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "abort",
             metadata,
             settings,
             prompt,
         }),
         getFailureEvent: (metadata, settings, error) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "failure",
             metadata,
             settings,
@@ -56,7 +56,7 @@ async function generateJsonOrText(model, schemaDefinitions, prompt, options) {
             error,
         }),
         getSuccessEvent: (metadata, settings, response, output) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "success",
             metadata,
             settings,
@@ -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

@@ -32,20 +32,20 @@ export async function generateJsonOrText(model, schemaDefinitions, prompt, optio
             };
         },
         getStartEvent: (metadata, settings) => ({
-            type: "json-generation-started",
+            type: "json-or-text-generation-started",
             metadata,
             settings,
             prompt,
         }),
         getAbortEvent: (metadata, settings) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "abort",
             metadata,
             settings,
             prompt,
         }),
         getFailureEvent: (metadata, settings, error) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "failure",
             metadata,
             settings,
@@ -53,7 +53,7 @@ export async function generateJsonOrText(model, schemaDefinitions, prompt, optio
             error,
         }),
         getSuccessEvent: (metadata, settings, response, output) => ({
-            type: "json-generation-finished",
+            type: "json-or-text-generation-finished",
             status: "success",
             metadata,
             settings,
@@ -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

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.streamText = 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");
 const extractTextDeltas_js_1 = require("./extractTextDeltas.cjs");
 async function streamText(model, prompt, options) {
     if (options?.settings != null) {
@@ -17,7 +17,7 @@ async function streamText(model, prompt, options) {
     }
     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,
     });
@@ -31,7 +31,7 @@ async function streamText(model, prompt, options) {
         model: model.modelInformation,
         startEpochSeconds: durationMeasurement.startEpochSeconds,
     };
-    eventSource.notifyModelCallStarted({
+    eventSource.notifyRunFunctionStarted({
         type: "text-streaming-started",
         metadata: startMetadata,
         settings,
@@ -49,7 +49,7 @@ async function streamText(model, prompt, options) {
                 ...startMetadata,
                 durationInMs: durationMeasurement.durationInMs,
             };
-            eventSource.notifyModelCallFinished({
+            eventSource.notifyRunFunctionFinished({
                 type: "text-streaming-finished",
                 status: "success",
                 metadata: finishMetadata,
@@ -64,7 +64,7 @@ async function streamText(model, prompt, options) {
                 ...startMetadata,
                 durationInMs: durationMeasurement.durationInMs,
             };
-            eventSource.notifyModelCallFinished(error instanceof AbortError_js_1.AbortError
+            eventSource.notifyRunFunctionFinished(error instanceof AbortError_js_1.AbortError
                 ? {
                     type: "text-streaming-finished",
                     status: "abort",
@@ -88,7 +88,7 @@ async function streamText(model, prompt, options) {
             durationInMs: durationMeasurement.durationInMs,
         };
         if (result.isAborted) {
-            eventSource.notifyModelCallFinished({
+            eventSource.notifyRunFunctionFinished({
                 type: "text-streaming-finished",
                 status: "abort",
                 metadata: finishMetadata,
@@ -97,7 +97,7 @@ async function streamText(model, prompt, options) {
             });
             throw new AbortError_js_1.AbortError();
         }
-        eventSource.notifyModelCallFinished({
+        eventSource.notifyRunFunctionFinished({
             type: "text-streaming-finished",
             status: "failure",
             metadata: finishMetadata,
@@ -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

@@ -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";
 import { extractTextDeltas } from "./extractTextDeltas.js";
 export async function streamText(model, prompt, options) {
     if (options?.settings != null) {
@@ -14,7 +14,7 @@ export async function streamText(model, prompt, options) {
     }
     const run = options?.run;
     const settings = model.settings;
-    const eventSource = new ModelCallEventSource({
+    const eventSource = new RunFunctionEventSource({
         observers: [...(settings.observers ?? []), ...(run?.observers ?? [])],
         errorHandler: run?.errorHandler,
     });
@@ -28,7 +28,7 @@ export async function streamText(model, prompt, options) {
         model: model.modelInformation,
         startEpochSeconds: durationMeasurement.startEpochSeconds,
     };
-    eventSource.notifyModelCallStarted({
+    eventSource.notifyRunFunctionStarted({
         type: "text-streaming-started",
         metadata: startMetadata,
         settings,
@@ -46,7 +46,7 @@ export async function streamText(model, prompt, options) {
                 ...startMetadata,
                 durationInMs: durationMeasurement.durationInMs,
             };
-            eventSource.notifyModelCallFinished({
+            eventSource.notifyRunFunctionFinished({
                 type: "text-streaming-finished",
                 status: "success",
                 metadata: finishMetadata,
@@ -61,7 +61,7 @@ export async function streamText(model, prompt, options) {
                 ...startMetadata,
                 durationInMs: durationMeasurement.durationInMs,
             };
-            eventSource.notifyModelCallFinished(error instanceof AbortError
+            eventSource.notifyRunFunctionFinished(error instanceof AbortError
                 ? {
                     type: "text-streaming-finished",
                     status: "abort",
@@ -85,7 +85,7 @@ export async function streamText(model, prompt, options) {
             durationInMs: durationMeasurement.durationInMs,
         };
         if (result.isAborted) {
-            eventSource.notifyModelCallFinished({
+            eventSource.notifyRunFunctionFinished({
                 type: "text-streaming-finished",
                 status: "abort",
                 metadata: finishMetadata,
@@ -94,7 +94,7 @@ export async function streamText(model, prompt, options) {
             });
             throw new AbortError();
         }
-        eventSource.notifyModelCallFinished({
+        eventSource.notifyRunFunctionFinished({
             type: "text-streaming-finished",
             status: "failure",
             metadata: finishMetadata,
@@ -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/index.cjs

@@ -17,7 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./FunctionOptions.cjs"), exports);
 __exportStar(require("./Model.cjs"), exports);
 __exportStar(require("./ModelCallEvent.cjs"), exports);
-__exportStar(require("./ModelCallObserver.cjs"), exports);
+__exportStar(require("../run/RunFunctionObserver.cjs"), exports);
 __exportStar(require("./ModelInformation.cjs"), exports);
 __exportStar(require("./SuccessfulModelCall.cjs"), exports);
 __exportStar(require("./embed-text/TextEmbeddingEvent.cjs"), exports);

package/model-function/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./FunctionOptions.js";
 export * from "./Model.js";
 export * from "./ModelCallEvent.js";
-export * from "./ModelCallObserver.js";
+export * from "../run/RunFunctionObserver.js";
 export * from "./ModelInformation.js";
 export * from "./SuccessfulModelCall.js";
 export * from "./embed-text/TextEmbeddingEvent.js";

package/model-function/index.js

@@ -1,7 +1,7 @@
 export * from "./FunctionOptions.js";
 export * from "./Model.js";
 export * from "./ModelCallEvent.js";
-export * from "./ModelCallObserver.js";
+export * from "../run/RunFunctionObserver.js";
 export * from "./ModelInformation.js";
 export * from "./SuccessfulModelCall.js";
 export * from "./embed-text/TextEmbeddingEvent.js";

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/automatic1111/Automatic1111ImageGenerationModel.d.ts

@@ -15,8 +15,8 @@ export declare class Automatic1111ImageGenerationModel extends AbstractModel<Aut
     get modelName(): string;
     callAPI(input: A111ImageGenerationPrompt, options?: FunctionOptions<Automatic1111ImageGenerationModelSettings>): Promise<Automatic1111ImageGenerationResponse>;
     generateImageResponse(prompt: A111ImageGenerationPrompt, options?: FunctionOptions<Automatic1111ImageGenerationModelSettings>): Promise<{
-        parameters: {};
         images: string[];
+        parameters: {};
         info: string;
     }>;
     extractBase64Image(response: Automatic1111ImageGenerationResponse): string;
@@ -37,12 +37,12 @@ declare const Automatic1111ImageGenerationResponseSchema: z.ZodObject<{
     parameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     info: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    parameters: {};
     images: string[];
+    parameters: {};
     info: string;
 }, {
-    parameters: {};
     images: string[];
+    parameters: {};
     info: string;
 }>;
 export type Automatic1111ImageGenerationResponse = z.infer<typeof Automatic1111ImageGenerationResponseSchema>;