modelfusion 0.133.0 → 0.134.0

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

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectFromTextStreamingModel = void 0;
-const streamText_js_1 = require("../generate-text/streamText.cjs");
-const AsyncQueue_js_1 = require("../../util/AsyncQueue.cjs");
-const parsePartialJson_js_1 = require("../../util/parsePartialJson.cjs");
-const ObjectFromTextGenerationModel_js_1 = require("./ObjectFromTextGenerationModel.cjs");
-class ObjectFromTextStreamingModel extends ObjectFromTextGenerationModel_js_1.ObjectFromTextGenerationModel {
-    constructor(options) {
-        super(options);
-    }
-    async doStreamObject(schema, prompt, options) {
-        const textStream = await (0, streamText_js_1.streamText)({
-            model: this.getModelWithJsonOutput(schema),
-            prompt: this.template.createPrompt(prompt, schema),
-            ...options,
-        });
-        const queue = new AsyncQueue_js_1.AsyncQueue();
-        // run async on purpose:
-        (async () => {
-            try {
-                for await (const deltaText of textStream) {
-                    queue.push({ type: "delta", deltaValue: deltaText });
-                }
-            }
-            catch (error) {
-                queue.push({ type: "error", error });
-            }
-            finally {
-                queue.close();
-            }
-        })();
-        return queue;
-    }
-    extractObjectTextDelta(delta) {
-        return delta;
-    }
-    parseAccumulatedObjectText(accumulatedText) {
-        return (0, parsePartialJson_js_1.parsePartialJson)(accumulatedText);
-    }
-    withSettings(additionalSettings) {
-        return new ObjectFromTextStreamingModel({
-            model: this.model.withSettings(additionalSettings),
-            template: this.template,
-        });
-    }
-}
-exports.ObjectFromTextStreamingModel = ObjectFromTextStreamingModel;

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

@@ -1,19 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { Delta } from "../Delta.js";
-import { AsyncQueue } from "../../util/AsyncQueue.js";
-import { TextGenerationModelSettings, TextStreamingModel } from "../generate-text/TextGenerationModel.js";
-import { ObjectFromTextGenerationModel } from "./ObjectFromTextGenerationModel.js";
-import { ObjectFromTextPromptTemplate } from "./ObjectFromTextPromptTemplate.js";
-import { ObjectStreamingModel } from "./ObjectGenerationModel.js";
-export declare class ObjectFromTextStreamingModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextStreamingModel<TARGET_PROMPT, TextGenerationModelSettings>> extends ObjectFromTextGenerationModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL> implements ObjectStreamingModel<SOURCE_PROMPT, MODEL["settings"]> {
-    constructor(options: {
-        model: MODEL;
-        template: ObjectFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
-    });
-    doStreamObject(schema: Schema<unknown> & JsonSchemaProducer, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<AsyncQueue<Delta<string>>>;
-    extractObjectTextDelta(delta: unknown): string;
-    parseAccumulatedObjectText(accumulatedText: string): unknown;
-    withSettings(additionalSettings: Partial<MODEL["settings"]>): this;
-}

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

@@ -1,44 +0,0 @@
-import { streamText } from "../generate-text/streamText.js";
-import { AsyncQueue } from "../../util/AsyncQueue.js";
-import { parsePartialJson } from "../../util/parsePartialJson.js";
-import { ObjectFromTextGenerationModel } from "./ObjectFromTextGenerationModel.js";
-export class ObjectFromTextStreamingModel extends ObjectFromTextGenerationModel {
-    constructor(options) {
-        super(options);
-    }
-    async doStreamObject(schema, prompt, options) {
-        const textStream = await streamText({
-            model: this.getModelWithJsonOutput(schema),
-            prompt: this.template.createPrompt(prompt, schema),
-            ...options,
-        });
-        const queue = new AsyncQueue();
-        // run async on purpose:
-        (async () => {
-            try {
-                for await (const deltaText of textStream) {
-                    queue.push({ type: "delta", deltaValue: deltaText });
-                }
-            }
-            catch (error) {
-                queue.push({ type: "error", error });
-            }
-            finally {
-                queue.close();
-            }
-        })();
-        return queue;
-    }
-    extractObjectTextDelta(delta) {
-        return delta;
-    }
-    parseAccumulatedObjectText(accumulatedText) {
-        return parsePartialJson(accumulatedText);
-    }
-    withSettings(additionalSettings) {
-        return new ObjectFromTextStreamingModel({
-            model: this.model.withSettings(additionalSettings),
-            template: this.template,
-        });
-    }
-}

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

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

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

@@ -1,23 +0,0 @@
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface ObjectGenerationStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "generate-object";
-}
-export type ObjectGenerationFinishedEventResult = {
-    status: "success";
-    rawResponse: unknown;
-    value: unknown;
-    usage?: {
-        promptTokens: number;
-        completionTokens: number;
-        totalTokens: number;
-    };
-} | {
-    status: "error";
-    error: unknown;
-} | {
-    status: "abort";
-};
-export type ObjectGenerationFinishedEvent = BaseModelCallFinishedEvent & {
-    functionType: "generate-object";
-    result: ObjectGenerationFinishedEventResult;
-};

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

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

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

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

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

@@ -1,24 +0,0 @@
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { Delta } from "../Delta.js";
-import { Model, ModelSettings } from "../Model.js";
-export interface ObjectGenerationModelSettings extends ModelSettings {
-}
-export interface ObjectGenerationModel<PROMPT, SETTINGS extends ObjectGenerationModelSettings = ObjectGenerationModelSettings> extends Model<SETTINGS> {
-    doGenerateObject(schema: Schema<unknown> & JsonSchemaProducer, prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
-        rawResponse: unknown;
-        valueText: string;
-        value: unknown;
-        usage?: {
-            promptTokens: number;
-            completionTokens: number;
-            totalTokens: number;
-        };
-    }>;
-}
-export interface ObjectStreamingModel<PROMPT, SETTINGS extends ObjectGenerationModelSettings = ObjectGenerationModelSettings> extends ObjectGenerationModel<PROMPT, SETTINGS> {
-    doStreamObject(schema: Schema<unknown> & JsonSchemaProducer, prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<Delta<unknown>>>;
-    extractObjectTextDelta(delta: unknown): string | undefined;
-    parseAccumulatedObjectText(accumulatedText: string): unknown;
-}

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

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

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

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectParseError = void 0;
-const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
-class ObjectParseError extends Error {
-    constructor({ valueText, cause }) {
-        super(`Object parsing failed. ` +
-            `Value: ${valueText}.\n` +
-            `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
-        Object.defineProperty(this, "cause", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "valueText", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "ObjectParseError";
-        this.cause = cause;
-        this.valueText = valueText;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            cause: this.cause,
-            message: this.message,
-            stack: this.stack,
-            valueText: this.valueText,
-        };
-    }
-}
-exports.ObjectParseError = ObjectParseError;

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

@@ -1,15 +0,0 @@
-export declare class ObjectParseError extends Error {
-    readonly cause: unknown;
-    readonly valueText: string;
-    constructor({ valueText, cause }: {
-        valueText: string;
-        cause: unknown;
-    });
-    toJSON(): {
-        name: string;
-        cause: unknown;
-        message: string;
-        stack: string | undefined;
-        valueText: string;
-    };
-}

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

@@ -1,32 +0,0 @@
-import { getErrorMessage } from "../../util/getErrorMessage.js";
-export class ObjectParseError extends Error {
-    constructor({ valueText, cause }) {
-        super(`Object parsing failed. ` +
-            `Value: ${valueText}.\n` +
-            `Error message: ${getErrorMessage(cause)}`);
-        Object.defineProperty(this, "cause", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "valueText", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "ObjectParseError";
-        this.cause = cause;
-        this.valueText = valueText;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            cause: this.cause,
-            message: this.message,
-            stack: this.stack,
-            valueText: this.valueText,
-        };
-    }
-}

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

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectStreamFromResponse = exports.ObjectStreamResponse = void 0;
-const parsePartialJson_js_1 = require("../../util/parsePartialJson.cjs");
-/**
- * Response for ObjectStream. The object stream is encoded as a text stream.
- *
- * Example:
- * ```ts
- * return new ObjectStreamResponse(objectStream);
- * ```
- */
-class ObjectStreamResponse extends Response {
-    constructor(stream, init) {
-        super(ObjectStreamToTextStream(stream), {
-            ...init,
-            status: 200,
-            headers: { "Content-Type": "text/plain; charset=utf-8" },
-        });
-    }
-}
-exports.ObjectStreamResponse = ObjectStreamResponse;
-/**
- * Convert a Response to a lightweight ObjectStream. The response must be created
- * using ObjectStreamResponse on the server.
- *
- * @see ObjectStreamResponse
- */
-async function* ObjectStreamFromResponse({ response, }) {
-    let text = "";
-    const reader = response.body.getReader();
-    // eslint-disable-next-line no-constant-condition
-    while (true) {
-        const { done, value } = await reader.read();
-        if (done)
-            break;
-        text += new TextDecoder().decode(value);
-        const partialObject = (0, parsePartialJson_js_1.parsePartialJson)(text);
-        yield { partialObject };
-    }
-}
-exports.ObjectStreamFromResponse = ObjectStreamFromResponse;
-function ObjectStreamToTextStream(stream) {
-    const textEncoder = new TextEncoder();
-    return new ReadableStream({
-        async start(controller) {
-            try {
-                for await (const { textDelta } of stream) {
-                    controller.enqueue(textEncoder.encode(textDelta));
-                }
-            }
-            finally {
-                controller.close();
-            }
-        },
-    });
-}

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

@@ -1,32 +0,0 @@
-import type { PartialDeep } from "type-fest";
-import { Schema } from "../../core/schema/Schema.js";
-export type ObjectStream<OBJECT> = AsyncIterable<{
-    partialObject: PartialDeep<OBJECT, {
-        recurseIntoArrays: true;
-    }>;
-    partialText: string;
-    textDelta: string;
-}>;
-/**
- * Response for ObjectStream. The object stream is encoded as a text stream.
- *
- * Example:
- * ```ts
- * return new ObjectStreamResponse(objectStream);
- * ```
- */
-export declare class ObjectStreamResponse extends Response {
-    constructor(stream: ObjectStream<unknown>, init?: ResponseInit);
-}
-/**
- * Convert a Response to a lightweight ObjectStream. The response must be created
- * using ObjectStreamResponse on the server.
- *
- * @see ObjectStreamResponse
- */
-export declare function ObjectStreamFromResponse<OBJECT>({ response, }: {
-    schema: Schema<OBJECT>;
-    response: Response;
-}): AsyncGenerator<{
-    partialObject: OBJECT;
-}, void, unknown>;

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

@@ -1,52 +0,0 @@
-import { parsePartialJson } from "../../util/parsePartialJson.js";
-/**
- * Response for ObjectStream. The object stream is encoded as a text stream.
- *
- * Example:
- * ```ts
- * return new ObjectStreamResponse(objectStream);
- * ```
- */
-export class ObjectStreamResponse extends Response {
-    constructor(stream, init) {
-        super(ObjectStreamToTextStream(stream), {
-            ...init,
-            status: 200,
-            headers: { "Content-Type": "text/plain; charset=utf-8" },
-        });
-    }
-}
-/**
- * Convert a Response to a lightweight ObjectStream. The response must be created
- * using ObjectStreamResponse on the server.
- *
- * @see ObjectStreamResponse
- */
-export async function* ObjectStreamFromResponse({ response, }) {
-    let text = "";
-    const reader = response.body.getReader();
-    // eslint-disable-next-line no-constant-condition
-    while (true) {
-        const { done, value } = await reader.read();
-        if (done)
-            break;
-        text += new TextDecoder().decode(value);
-        const partialObject = parsePartialJson(text);
-        yield { partialObject };
-    }
-}
-function ObjectStreamToTextStream(stream) {
-    const textEncoder = new TextEncoder();
-    return new ReadableStream({
-        async start(controller) {
-            try {
-                for await (const { textDelta } of stream) {
-                    controller.enqueue(textEncoder.encode(textDelta));
-                }
-            }
-            finally {
-                controller.close();
-            }
-        },
-    });
-}

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

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

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

@@ -1,7 +0,0 @@
-import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../ModelCallEvent.js";
-export interface ObjectStreamingStartedEvent extends BaseModelCallStartedEvent {
-    functionType: "stream-object";
-}
-export interface ObjectStreamingFinishedEvent extends BaseModelCallFinishedEvent {
-    functionType: "stream-object";
-}

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

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

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

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectValidationError = void 0;
-const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
-class ObjectValidationError extends Error {
-    constructor({ value, valueText, cause, }) {
-        super(`Object validation failed. ` +
-            `Value: ${valueText}.\n` +
-            `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
-        Object.defineProperty(this, "cause", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "valueText", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "value", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "ObjectValidationError";
-        this.cause = cause;
-        this.value = value;
-        this.valueText = valueText;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            message: this.message,
-            cause: this.cause,
-            stack: this.stack,
-            value: this.value,
-            valueText: this.valueText,
-        };
-    }
-}
-exports.ObjectValidationError = ObjectValidationError;

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

@@ -1,18 +0,0 @@
-export declare class ObjectValidationError extends Error {
-    readonly cause: unknown;
-    readonly valueText: string;
-    readonly value: unknown;
-    constructor({ value, valueText, cause, }: {
-        value: unknown;
-        valueText: string;
-        cause: unknown;
-    });
-    toJSON(): {
-        name: string;
-        message: string;
-        cause: unknown;
-        stack: string | undefined;
-        value: unknown;
-        valueText: string;
-    };
-}

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

@@ -1,40 +0,0 @@
-import { getErrorMessage } from "../../util/getErrorMessage.js";
-export class ObjectValidationError extends Error {
-    constructor({ value, valueText, cause, }) {
-        super(`Object validation failed. ` +
-            `Value: ${valueText}.\n` +
-            `Error message: ${getErrorMessage(cause)}`);
-        Object.defineProperty(this, "cause", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "valueText", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "value", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "ObjectValidationError";
-        this.cause = cause;
-        this.value = value;
-        this.valueText = valueText;
-    }
-    toJSON() {
-        return {
-            name: this.name,
-            message: this.message,
-            cause: this.cause,
-            stack: this.stack,
-            value: this.value,
-            valueText: this.valueText,
-        };
-    }
-}

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

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateObject = void 0;
-const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
-const ObjectValidationError_js_1 = require("./ObjectValidationError.cjs");
-async function generateObject({ model, schema, prompt, fullResponse, ...options }) {
-    // Note: PROMPT must not be a function.
-    const expandedPrompt = typeof prompt === "function"
-        ? prompt(schema)
-        : prompt;
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "generate-object",
-        input: {
-            schema,
-            prompt: expandedPrompt,
-        },
-        model,
-        options,
-        generateResponse: async (options) => {
-            const result = await model.doGenerateObject(schema, expandedPrompt, options);
-            const parseResult = schema.validate(result.value);
-            if (!parseResult.success) {
-                throw new ObjectValidationError_js_1.ObjectValidationError({
-                    valueText: result.valueText,
-                    value: result.value,
-                    cause: parseResult.error,
-                });
-            }
-            const value = parseResult.value;
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: value,
-                usage: result.usage,
-            };
-        },
-    });
-    return fullResponse
-        ? {
-            value: callResponse.value,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : callResponse.value;
-}
-exports.generateObject = generateObject;

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

@@ -1,56 +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 { ObjectGenerationModel, ObjectGenerationModelSettings } from "./ObjectGenerationModel.js";
-/**
- * Generate a typed object for a prompt and a schema.
- *
- * @see https://modelfusion.dev/guide/function/generate-object
- *
- * @example
- * const sentiment = await generateObject({
- *   model: openai.ChatTextGenerator(...).asFunctionCallObjectGenerationModel(...),
- *
- *   schema: zodSchema(z.object({
- *     sentiment: z
- *       .enum(["positive", "neutral", "negative"])
- *       .describe("Sentiment."),
- *   })),
- *
- *   prompt: [
- *     openai.ChatMessage.system(
- *       "You are a sentiment evaluator. " +
- *         "Analyze the sentiment of the following product review:"
- *     ),
- *     openai.ChatMessage.user(
- *       "After I opened the package, I was met by a very unpleasant smell " +
- *         "that did not disappear even after washing. Never again!"
- *     ),
- *   ]
- * });
- *
- * @param {ObjectGenerationModel<PROMPT, SETTINGS>} options.model - The model to generate the object.
- * @param {Schema<OBJECT>} options.schema - The schema to be used.
- * @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.
- *
- * @returns {Promise<OBJECT>} - Returns a promise that resolves to the generated object.
- */
-export declare function generateObject<OBJECT, PROMPT, SETTINGS extends ObjectGenerationModelSettings>(args: {
-    model: ObjectGenerationModel<PROMPT, SETTINGS>;
-    schema: Schema<OBJECT> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<OBJECT>) => PROMPT);
-    fullResponse?: false;
-} & FunctionOptions): Promise<OBJECT>;
-export declare function generateObject<OBJECT, PROMPT, SETTINGS extends ObjectGenerationModelSettings>(args: {
-    model: ObjectGenerationModel<PROMPT, SETTINGS>;
-    schema: Schema<OBJECT> & JsonSchemaProducer;
-    prompt: PROMPT | ((schema: Schema<OBJECT>) => PROMPT);
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    value: OBJECT;
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;