modelfusion 0.133.0 → 0.135.0

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

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

@@ -1,41 +0,0 @@
-import { executeStandardCall } from "../executeStandardCall.js";
-import { ObjectValidationError } from "./ObjectValidationError.js";
-export 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 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({
-                    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;
-}

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

@@ -1,28 +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("./ObjectFromTextGenerationModel.cjs"), exports);
-__exportStar(require("./ObjectFromTextPromptTemplate.cjs"), exports);
-__exportStar(require("./ObjectFromTextStreamingModel.cjs"), exports);
-__exportStar(require("./ObjectGenerationEvent.cjs"), exports);
-__exportStar(require("./ObjectGenerationModel.cjs"), exports);
-__exportStar(require("./ObjectParseError.cjs"), exports);
-__exportStar(require("./ObjectStream.cjs"), exports);
-__exportStar(require("./ObjectStreamingEvent.cjs"), exports);
-__exportStar(require("./ObjectValidationError.cjs"), exports);
-__exportStar(require("./generateObject.cjs"), exports);
-__exportStar(require("./jsonObjectPrompt.cjs"), exports);
-__exportStar(require("./streamObject.cjs"), exports);

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

@@ -1,12 +0,0 @@
-export * from "./ObjectFromTextGenerationModel.js";
-export * from "./ObjectFromTextPromptTemplate.js";
-export * from "./ObjectFromTextStreamingModel.js";
-export * from "./ObjectGenerationEvent.js";
-export * from "./ObjectGenerationModel.js";
-export * from "./ObjectParseError.js";
-export * from "./ObjectStream.js";
-export * from "./ObjectStreamingEvent.js";
-export * from "./ObjectValidationError.js";
-export * from "./generateObject.js";
-export * from "./jsonObjectPrompt.js";
-export * from "./streamObject.js";

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

@@ -1,12 +0,0 @@
-export * from "./ObjectFromTextGenerationModel.js";
-export * from "./ObjectFromTextPromptTemplate.js";
-export * from "./ObjectFromTextStreamingModel.js";
-export * from "./ObjectGenerationEvent.js";
-export * from "./ObjectGenerationModel.js";
-export * from "./ObjectParseError.js";
-export * from "./ObjectStream.js";
-export * from "./ObjectStreamingEvent.js";
-export * from "./ObjectValidationError.js";
-export * from "./generateObject.js";
-export * from "./jsonObjectPrompt.js";
-export * from "./streamObject.js";

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

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonObjectPrompt = void 0;
-const parseJSON_js_1 = require("../../core/schema/parseJSON.cjs");
-const DEFAULT_SCHEMA_PREFIX = "JSON schema:";
-const DEFAULT_SCHEMA_SUFFIX = "\nYou MUST answer with a JSON object matches the above schema.";
-exports.jsonObjectPrompt = {
-    custom(createPrompt) {
-        return { createPrompt, extractObject };
-    },
-    text({ schemaPrefix, schemaSuffix, } = {}) {
-        return {
-            createPrompt: (prompt, schema) => ({
-                system: createSystemPrompt({ schema, schemaPrefix, schemaSuffix }),
-                instruction: prompt,
-            }),
-            extractObject,
-            adaptModel: (model) => model.withInstructionPrompt(),
-            withJsonOutput: ({ model, schema }) => model.withJsonOutput(schema),
-        };
-    },
-    instruction({ schemaPrefix, schemaSuffix, } = {}) {
-        return {
-            createPrompt: (prompt, schema) => ({
-                system: createSystemPrompt({
-                    originalSystemPrompt: prompt.system,
-                    schema,
-                    schemaPrefix,
-                    schemaSuffix,
-                }),
-                instruction: prompt.instruction,
-            }),
-            extractObject,
-            adaptModel: (model) => model.withInstructionPrompt(),
-            withJsonOutput: ({ model, schema }) => model.withJsonOutput(schema),
-        };
-    },
-};
-function createSystemPrompt({ originalSystemPrompt, schema, schemaPrefix = DEFAULT_SCHEMA_PREFIX, schemaSuffix = DEFAULT_SCHEMA_SUFFIX, }) {
-    return [
-        originalSystemPrompt,
-        schemaPrefix,
-        JSON.stringify(schema.getJsonSchema()),
-        schemaSuffix,
-    ]
-        .filter(Boolean)
-        .join("\n");
-}
-function extractObject(response) {
-    return (0, parseJSON_js_1.parseJSON)({ text: response });
-}

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

@@ -1,15 +0,0 @@
-import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
-import { Schema } from "../../core/schema/Schema.js";
-import { InstructionPrompt } from "../generate-text/prompt-template/InstructionPrompt.js";
-import { FlexibleObjectFromTextPromptTemplate, ObjectFromTextPromptTemplate } from "./ObjectFromTextPromptTemplate.js";
-export declare const jsonObjectPrompt: {
-    custom<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): ObjectFromTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
-    text({ schemaPrefix, schemaSuffix, }?: {
-        schemaPrefix?: string | undefined;
-        schemaSuffix?: string | undefined;
-    }): FlexibleObjectFromTextPromptTemplate<string, InstructionPrompt>;
-    instruction({ schemaPrefix, schemaSuffix, }?: {
-        schemaPrefix?: string | undefined;
-        schemaSuffix?: string | undefined;
-    }): FlexibleObjectFromTextPromptTemplate<InstructionPrompt, InstructionPrompt>;
-};

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

@@ -1,48 +0,0 @@
-import { parseJSON } from "../../core/schema/parseJSON.js";
-const DEFAULT_SCHEMA_PREFIX = "JSON schema:";
-const DEFAULT_SCHEMA_SUFFIX = "\nYou MUST answer with a JSON object matches the above schema.";
-export const jsonObjectPrompt = {
-    custom(createPrompt) {
-        return { createPrompt, extractObject };
-    },
-    text({ schemaPrefix, schemaSuffix, } = {}) {
-        return {
-            createPrompt: (prompt, schema) => ({
-                system: createSystemPrompt({ schema, schemaPrefix, schemaSuffix }),
-                instruction: prompt,
-            }),
-            extractObject,
-            adaptModel: (model) => model.withInstructionPrompt(),
-            withJsonOutput: ({ model, schema }) => model.withJsonOutput(schema),
-        };
-    },
-    instruction({ schemaPrefix, schemaSuffix, } = {}) {
-        return {
-            createPrompt: (prompt, schema) => ({
-                system: createSystemPrompt({
-                    originalSystemPrompt: prompt.system,
-                    schema,
-                    schemaPrefix,
-                    schemaSuffix,
-                }),
-                instruction: prompt.instruction,
-            }),
-            extractObject,
-            adaptModel: (model) => model.withInstructionPrompt(),
-            withJsonOutput: ({ model, schema }) => model.withJsonOutput(schema),
-        };
-    },
-};
-function createSystemPrompt({ originalSystemPrompt, schema, schemaPrefix = DEFAULT_SCHEMA_PREFIX, schemaSuffix = DEFAULT_SCHEMA_SUFFIX, }) {
-    return [
-        originalSystemPrompt,
-        schemaPrefix,
-        JSON.stringify(schema.getJsonSchema()),
-        schemaSuffix,
-    ]
-        .filter(Boolean)
-        .join("\n");
-}
-function extractObject(response) {
-    return parseJSON({ text: response });
-}