modelfusion 0.133.0 → 0.135.0

package/model-function/generate-object/streamObject.cjs

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamObject = void 0;
-const isDeepEqualData_js_1 = require("../../util/isDeepEqualData.cjs");
-const executeStreamCall_js_1 = require("../executeStreamCall.cjs");
-async function streamObject({ model, schema, prompt, fullResponse, ...options }) {
-    // Note: PROMPT must not be a function.
-    const expandedPrompt = typeof prompt === "function"
-        ? prompt(schema)
-        : prompt;
-    let accumulatedText = "";
-    let accumulatedTextDelta = "";
-    let latestObject;
-    let resolveObject;
-    let rejectObject;
-    const objectPromise = new Promise((resolve, reject) => {
-        resolveObject = resolve;
-        rejectObject = reject;
-    });
-    const callResponse = await (0, executeStreamCall_js_1.executeStreamCall)({
-        functionType: "stream-object",
-        input: {
-            schema,
-            prompt: expandedPrompt,
-        },
-        model,
-        options,
-        startStream: async (options) => model.doStreamObject(schema, expandedPrompt, options),
-        processDelta(delta) {
-            const textDelta = model.extractObjectTextDelta(delta.deltaValue);
-            if (textDelta == null) {
-                return undefined;
-            }
-            accumulatedText += textDelta;
-            accumulatedTextDelta += textDelta;
-            const currentObject = model.parseAccumulatedObjectText(accumulatedText);
-            // only send a new part into the stream when the partial object has changed:
-            if (!(0, isDeepEqualData_js_1.isDeepEqualData)(latestObject, currentObject)) {
-                latestObject = currentObject;
-                // reset delta accumulation:
-                const currentAccumulatedTextDelta = accumulatedTextDelta;
-                accumulatedTextDelta = "";
-                // TODO add type checking
-                return {
-                    partialObject: latestObject,
-                    partialText: accumulatedText,
-                    textDelta: currentAccumulatedTextDelta,
-                };
-            }
-            return undefined;
-        },
-        // The last object is processed and returned, even if it was already returned previously.
-        // The reason is that the full text delta should be returned (and no characters should be omitted).
-        processFinished() {
-            return {
-                partialObject: latestObject,
-                partialText: accumulatedText,
-                textDelta: accumulatedTextDelta,
-            };
-        },
-        onDone() {
-            // process the final result (full type validation):
-            const parseResult = schema.validate(latestObject);
-            if (parseResult.success) {
-                resolveObject(parseResult.value);
-            }
-            else {
-                rejectObject(parseResult.error);
-            }
-        },
-    });
-    return fullResponse
-        ? {
-            objectStream: callResponse.value,
-            objectPromise: objectPromise,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.streamObject = streamObject;

package/model-function/generate-object/streamObject.d.ts

@@ -1,57 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { ObjectStreamingModel } from "./ObjectGenerationModel.js";
-import { ObjectStream } from "./ObjectStream.js";
-/**
- * Generate and stream an object for a prompt and a schema.
- *
- * @see https://modelfusion.dev/guide/function/generate-object
- *
- * @example
- * const objectStream = await streamObject({
- *   model: openai.ChatTextGenerator(...).asFunctionCallObjectGenerationModel(...),
- *   schema: zodSchema(
- *     z.array(
- *       z.object({
- *         name: z.string(),
- *         class: z
- *           .string()
- *           .describe("Character class, e.g. warrior, mage, or thief."),
- *         description: z.string(),
- *       })
- *     ),
- *   prompt: [
- *     openai.ChatMessage.user(
- *       "Generate 3 character descriptions for a fantasy role playing game."
- *     ),
- *   ]
- * });
- *
- * for await (const { partialObject } of objectStream) {
- *   // ...
- * }
- *
- * @param {ObjectStreamingModel<PROMPT>} options.model - The model that generates the object
- * @param {Schema<OBJECT>} options.schema - The schema of the object to be generated.
- * @param {PROMPT | ((schema: Schema<OBJECT>) => PROMPT)} options.prompt
- * The prompt to be used.
- * You can also pass a function that takes the schema as an argument and returns the prompt.
- */
-export declare function streamObject<OBJECT, PROMPT>(args: {
-    model: ObjectStreamingModel<PROMPT>;
-    schema: Schema<OBJECT> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<OBJECT>) => PROMPT);
-    fullResponse?: false;
-} & FunctionOptions): Promise<ObjectStream<OBJECT>>;
-export declare function streamObject<OBJECT, PROMPT>(args: {
-    model: ObjectStreamingModel<PROMPT>;
-    schema: Schema<OBJECT> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<OBJECT>) => PROMPT);
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    objectStream: ObjectStream<OBJECT>;
-    objectPromise: PromiseLike<OBJECT>;
-    metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
-}>;

package/model-function/generate-object/streamObject.js

@@ -1,76 +0,0 @@
-import { isDeepEqualData } from "../../util/isDeepEqualData.js";
-import { executeStreamCall } from "../executeStreamCall.js";
-export async function streamObject({ model, schema, prompt, fullResponse, ...options }) {
-    // Note: PROMPT must not be a function.
-    const expandedPrompt = typeof prompt === "function"
-        ? prompt(schema)
-        : prompt;
-    let accumulatedText = "";
-    let accumulatedTextDelta = "";
-    let latestObject;
-    let resolveObject;
-    let rejectObject;
-    const objectPromise = new Promise((resolve, reject) => {
-        resolveObject = resolve;
-        rejectObject = reject;
-    });
-    const callResponse = await executeStreamCall({
-        functionType: "stream-object",
-        input: {
-            schema,
-            prompt: expandedPrompt,
-        },
-        model,
-        options,
-        startStream: async (options) => model.doStreamObject(schema, expandedPrompt, options),
-        processDelta(delta) {
-            const textDelta = model.extractObjectTextDelta(delta.deltaValue);
-            if (textDelta == null) {
-                return undefined;
-            }
-            accumulatedText += textDelta;
-            accumulatedTextDelta += textDelta;
-            const currentObject = model.parseAccumulatedObjectText(accumulatedText);
-            // only send a new part into the stream when the partial object has changed:
-            if (!isDeepEqualData(latestObject, currentObject)) {
-                latestObject = currentObject;
-                // reset delta accumulation:
-                const currentAccumulatedTextDelta = accumulatedTextDelta;
-                accumulatedTextDelta = "";
-                // TODO add type checking
-                return {
-                    partialObject: latestObject,
-                    partialText: accumulatedText,
-                    textDelta: currentAccumulatedTextDelta,
-                };
-            }
-            return undefined;
-        },
-        // The last object is processed and returned, even if it was already returned previously.
-        // The reason is that the full text delta should be returned (and no characters should be omitted).
-        processFinished() {
-            return {
-                partialObject: latestObject,
-                partialText: accumulatedText,
-                textDelta: accumulatedTextDelta,
-            };
-        },
-        onDone() {
-            // process the final result (full type validation):
-            const parseResult = schema.validate(latestObject);
-            if (parseResult.success) {
-                resolveObject(parseResult.value);
-            }
-            else {
-                rejectObject(parseResult.error);
-            }
-        },
-    });
-    return fullResponse
-        ? {
-            objectStream: callResponse.value,
-            objectPromise: objectPromise,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,26 +0,0 @@
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface SpeechGenerationStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "generate-speech";
-    input: string;
-}
-export type SpeechGenerationFinishedEventResult = {
-    status: "success";
-    rawResponse: unknown;
-    value: Uint8Array;
-} | {
-    status: "error";
-    error: unknown;
-} | {
-    status: "abort";
-};
-export interface SpeechGenerationFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "generate-speech";
-    input: string;
-    result: SpeechGenerationFinishedEventResult;
-}
-export interface SpeechStreamingStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "stream-speech";
-}
-export interface SpeechStreamingFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "stream-speech";
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,14 +0,0 @@
-import { FunctionCallOptions } from "../../core/FunctionOptions.js";
-import { Delta } from "../Delta.js";
-import { Model, ModelSettings } from "../Model.js";
-export interface SpeechGenerationModelSettings extends ModelSettings {
-}
-export interface SpeechGenerationModel<SETTINGS extends SpeechGenerationModelSettings = SpeechGenerationModelSettings> extends Model<SETTINGS> {
-    /**
-     * Generates an mp3 audio Uint8Array that contains the speech for the given text.
-     */
-    doGenerateSpeechStandard(text: string, options: FunctionCallOptions): PromiseLike<Uint8Array>;
-}
-export interface StreamingSpeechGenerationModel<SETTINGS extends SpeechGenerationModelSettings = SpeechGenerationModelSettings> extends SpeechGenerationModel<SETTINGS> {
-    doGenerateSpeechStreamDuplex(textStream: AsyncIterable<string>, options: FunctionCallOptions): PromiseLike<AsyncIterable<Delta<Uint8Array>>>;
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSpeech = void 0;
-const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
-async function generateSpeech({ model, text, fullResponse, ...options }) {
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "generate-speech",
-        input: text,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const response = await model.doGenerateSpeechStandard(text, options);
-            return {
-                rawResponse: response,
-                extractedValue: response,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            speech: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.generateSpeech = generateSpeech;

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

@@ -1,34 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { SpeechGenerationModel, SpeechGenerationModelSettings } from "./SpeechGenerationModel.js";
-/**
- * Synthesizes speech from text. Also called text-to-speech (TTS).
- *
- * @see https://modelfusion.dev/guide/function/generate-speech
- *
- * @example
- * const speech = await generateSpeech({
- *   model: lmnt.SpeechGenerator(...),
- *   text: "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.
- *
- * @returns {Promise<Uint8Array>} - A promise that resolves to a Uint8Array containing the synthesized speech.
- */
-export declare function generateSpeech(args: {
-    model: SpeechGenerationModel<SpeechGenerationModelSettings>;
-    text: string;
-    fullResponse?: false;
-} & FunctionOptions): Promise<Uint8Array>;
-export declare function generateSpeech(args: {
-    model: SpeechGenerationModel<SpeechGenerationModelSettings>;
-    text: string;
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    speech: Uint8Array;
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;

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

@@ -1,23 +0,0 @@
-import { executeStandardCall } from "../executeStandardCall.js";
-export async function generateSpeech({ model, text, fullResponse, ...options }) {
-    const callResponse = await executeStandardCall({
-        functionType: "generate-speech",
-        input: text,
-        model,
-        options,
-        generateResponse: async (options) => {
-            const response = await model.doGenerateSpeechStandard(text, options);
-            return {
-                rawResponse: response,
-                extractedValue: response,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            speech: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}

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

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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("./SpeechGenerationEvent.cjs"), exports);
-__exportStar(require("./SpeechGenerationModel.cjs"), exports);
-__exportStar(require("./generateSpeech.cjs"), exports);
-__exportStar(require("./streamSpeech.cjs"), exports);

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

@@ -1,4 +0,0 @@
-export * from "./SpeechGenerationEvent.js";
-export * from "./SpeechGenerationModel.js";
-export * from "./generateSpeech.js";
-export * from "./streamSpeech.js";

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

@@ -1,4 +0,0 @@
-export * from "./SpeechGenerationEvent.js";
-export * from "./SpeechGenerationModel.js";
-export * from "./generateSpeech.js";
-export * from "./streamSpeech.js";

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

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamSpeech = void 0;
-const AsyncQueue_js_1 = require("../../util/AsyncQueue.cjs");
-const executeStreamCall_js_1 = require("../executeStreamCall.cjs");
-async function streamSpeech({ model, text, fullResponse, ...options }) {
-    let textStream;
-    // simulate a stream with a single value for a string input:
-    if (typeof text === "string") {
-        const queue = new AsyncQueue_js_1.AsyncQueue();
-        queue.push(text);
-        queue.close();
-        textStream = queue;
-    }
-    else {
-        textStream = text;
-    }
-    const callResponse = await (0, executeStreamCall_js_1.executeStreamCall)({
-        functionType: "stream-speech",
-        input: text,
-        model,
-        options,
-        startStream: async (options) => model.doGenerateSpeechStreamDuplex(textStream, options),
-        processDelta: (delta) => delta.deltaValue,
-    });
-    return fullResponse
-        ? {
-            speechStream: callResponse.value,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.streamSpeech = streamSpeech;

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

@@ -1,40 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { SpeechGenerationModelSettings, StreamingSpeechGenerationModel } from "./SpeechGenerationModel.js";
-/**
- * Stream synthesized speech from text. Also called text-to-speech (TTS).
- * Duplex streaming where both the input and output are streamed is supported.
- *
- * @see https://modelfusion.dev/guide/function/generate-speech
- *
- * @example
- * const textStream = await streamText(...);
- *
- * const speechStream = await streamSpeech({
- *   model: elevenlabs.SpeechGenerator(...),
- *   text: textStream
- * });
- *
- * for await (const speechPart of speechStream) {
- *   // ...
- * }
- *
- * @param {StreamingSpeechGenerationModel<SpeechGenerationModelSettings>} model - The speech generation model.
- * @param {AsyncIterable<string> | string} text - The text to be converted to speech. Can be a string or an async iterable of strings.
- * @param {FunctionOptions} [options] - Optional function options.
- *
- * @returns {AsyncIterableResultPromise<Uint8Array>} An async iterable promise that contains the synthesized speech chunks.
- */
-export declare function streamSpeech(args: {
-    model: StreamingSpeechGenerationModel<SpeechGenerationModelSettings>;
-    text: AsyncIterable<string> | string;
-    fullResponse?: false;
-} & FunctionOptions): Promise<AsyncIterable<Uint8Array>>;
-export declare function streamSpeech(args: {
-    model: StreamingSpeechGenerationModel<SpeechGenerationModelSettings>;
-    text: AsyncIterable<string> | string;
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    speechStream: AsyncIterable<Uint8Array>;
-    metadata: Omit<ModelCallMetadata, "durationInMs" | "finishTimestamp">;
-}>;

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

@@ -1,29 +0,0 @@
-import { AsyncQueue } from "../../util/AsyncQueue.js";
-import { executeStreamCall } from "../executeStreamCall.js";
-export async function streamSpeech({ model, text, fullResponse, ...options }) {
-    let textStream;
-    // simulate a stream with a single value for a string input:
-    if (typeof text === "string") {
-        const queue = new AsyncQueue();
-        queue.push(text);
-        queue.close();
-        textStream = queue;
-    }
-    else {
-        textStream = text;
-    }
-    const callResponse = await executeStreamCall({
-        functionType: "stream-speech",
-        input: text,
-        model,
-        options,
-        startStream: async (options) => model.doGenerateSpeechStreamDuplex(textStream, options),
-        processDelta: (delta) => delta.deltaValue,
-    });
-    return fullResponse
-        ? {
-            speechStream: callResponse.value,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}

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

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptTemplateFullTextModel = void 0;
-const PromptTemplateTextStreamingModel_js_1 = require("./PromptTemplateTextStreamingModel.cjs");
-class PromptTemplateFullTextModel extends PromptTemplateTextStreamingModel_js_1.PromptTemplateTextStreamingModel {
-    constructor(options) {
-        super(options);
-    }
-    doGenerateToolCall(tool, prompt, options) {
-        const mappedPrompt = this.promptTemplate.format(prompt);
-        return this.model.doGenerateToolCall(tool, mappedPrompt, options);
-    }
-    doGenerateToolCalls(tools, prompt, options) {
-        const mappedPrompt = this.promptTemplate.format(prompt);
-        return this.model.doGenerateToolCalls(tools, mappedPrompt, options);
-    }
-    withSettings(additionalSettings) {
-        return new PromptTemplateFullTextModel({
-            model: this.model.withSettings(additionalSettings),
-            promptTemplate: this.promptTemplate,
-        });
-    }
-}
-exports.PromptTemplateFullTextModel = PromptTemplateFullTextModel;

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

@@ -1,40 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ToolDefinition } from "../../tool/ToolDefinition.js";
-import { ToolCallGenerationModel } from "../../tool/generate-tool-call/ToolCallGenerationModel.js";
-import { ToolCallsGenerationModel } from "../../tool/generate-tool-calls/ToolCallsGenerationModel.js";
-import { PromptTemplateTextStreamingModel } from "./PromptTemplateTextStreamingModel.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "./TextGenerationModel.js";
-import { TextGenerationPromptTemplate } from "./TextGenerationPromptTemplate.js";
-export declare class PromptTemplateFullTextModel<PROMPT, MODEL_PROMPT, SETTINGS extends TextGenerationModelSettings, MODEL extends TextStreamingModel<MODEL_PROMPT, SETTINGS> & ToolCallGenerationModel<MODEL_PROMPT, SETTINGS> & ToolCallsGenerationModel<MODEL_PROMPT, SETTINGS>> extends PromptTemplateTextStreamingModel<PROMPT, MODEL_PROMPT, SETTINGS, MODEL> implements TextStreamingModel<PROMPT, SETTINGS>, ToolCallGenerationModel<PROMPT, SETTINGS>, ToolCallsGenerationModel<PROMPT, SETTINGS> {
-    constructor(options: {
-        model: MODEL;
-        promptTemplate: TextGenerationPromptTemplate<PROMPT, MODEL_PROMPT>;
-    });
-    doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: PROMPT, options?: FunctionOptions | undefined): PromiseLike<{
-        rawResponse: unknown;
-        toolCall: {
-            id: string;
-            args: unknown;
-        } | null;
-        usage?: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        } | undefined;
-    }>;
-    doGenerateToolCalls(tools: ToolDefinition<string, unknown>[], prompt: PROMPT, options?: FunctionOptions | undefined): PromiseLike<{
-        rawResponse: unknown;
-        text: string | null;
-        toolCalls: {
-            id: string;
-            name: string;
-            args: unknown;
-        }[] | null;
-        usage?: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        } | undefined;
-    }>;
-    withSettings(additionalSettings: Partial<SETTINGS>): this;
-}

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

@@ -1,20 +0,0 @@
-import { PromptTemplateTextStreamingModel } from "./PromptTemplateTextStreamingModel.js";
-export class PromptTemplateFullTextModel extends PromptTemplateTextStreamingModel {
-    constructor(options) {
-        super(options);
-    }
-    doGenerateToolCall(tool, prompt, options) {
-        const mappedPrompt = this.promptTemplate.format(prompt);
-        return this.model.doGenerateToolCall(tool, mappedPrompt, options);
-    }
-    doGenerateToolCalls(tools, prompt, options) {
-        const mappedPrompt = this.promptTemplate.format(prompt);
-        return this.model.doGenerateToolCalls(tools, mappedPrompt, options);
-    }
-    withSettings(additionalSettings) {
-        return new PromptTemplateFullTextModel({
-            model: this.model.withSettings(additionalSettings),
-            promptTemplate: this.promptTemplate,
-        });
-    }
-}