modelfusion 0.132.0 → 0.134.0

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

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

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

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

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

@@ -1,11 +0,0 @@
-export type TextGenerationResult = {
-    /**
-     * The generated text.
-     */
-    text: string;
-    /**
-     * The reason why the generation stopped.
-     */
-    finishReason: TextGenerationFinishReason;
-};
-export type TextGenerationFinishReason = "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown";

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

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

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

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateText = void 0;
-const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
-async function generateText({ model, prompt, fullResponse, ...options }) {
-    const callResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "generate-text",
-        input: prompt,
-        model,
-        options,
-        generateResponse: async (options) => {
-            async function getGeneratedTexts() {
-                if (options?.cache == null) {
-                    return {
-                        ...(await model.doGenerateTexts(prompt, options)),
-                        cache: undefined,
-                    };
-                }
-                let cacheErrors = undefined;
-                const cacheKey = {
-                    functionType: "generate-text",
-                    functionId: options?.functionId,
-                    input: {
-                        model,
-                        settings: model.settingsForEvent, // TODO should include full model information
-                        prompt,
-                    },
-                };
-                try {
-                    const cachedRawResponse = await options.cache.lookupValue(cacheKey);
-                    if (cachedRawResponse != null) {
-                        return {
-                            ...model.restoreGeneratedTexts(cachedRawResponse),
-                            cache: { status: "hit" },
-                        };
-                    }
-                }
-                catch (err) {
-                    cacheErrors = [err];
-                }
-                const result = await model.doGenerateTexts(prompt, options);
-                try {
-                    await options.cache.storeValue(cacheKey, result.rawResponse);
-                }
-                catch (err) {
-                    cacheErrors = [...(cacheErrors ?? []), err];
-                }
-                return {
-                    ...result,
-                    cache: { status: "miss", errors: cacheErrors },
-                };
-            }
-            const result = await getGeneratedTexts();
-            const shouldTrimWhitespace = model.settings.trimWhitespace ?? true;
-            const textGenerationResults = shouldTrimWhitespace
-                ? result.textGenerationResults.map((textGeneration) => ({
-                    text: textGeneration.text.trim(),
-                    finishReason: textGeneration.finishReason,
-                }))
-                : result.textGenerationResults;
-            // TODO add cache information
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: textGenerationResults,
-                usage: result.usage,
-            };
-        },
-    });
-    const textGenerationResults = callResponse.value;
-    const firstResult = textGenerationResults[0];
-    return fullResponse
-        ? {
-            text: firstResult.text,
-            finishReason: firstResult.finishReason,
-            texts: textGenerationResults.map((textGeneration) => textGeneration.text),
-            textGenerationResults,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : firstResult.text;
-}
-exports.generateText = generateText;

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

@@ -1,41 +0,0 @@
-import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { ModelCallMetadata } from "../ModelCallMetadata.js";
-import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerationModel.js";
-import { TextGenerationFinishReason, TextGenerationResult } from "./TextGenerationResult.js";
-/**
- * Generate text for a prompt and return it as a string.
- *
- * The prompt depends on the model used.
- * For instance, OpenAI completion models expect a string prompt,
- * whereas OpenAI chat models expect an array of chat messages.
- *
- * @see https://modelfusion.dev/guide/function/generate-text
- *
- * @example
- * const text = await generateText({
- *   model: openai.CompletionTextGenerator(...),
- *   prompt: "Write a short story about a robot learning to love:\n\n"
- * });
- *
- * @param {TextGenerationModel<PROMPT, TextGenerationModelSettings>} model - The text generation model to use.
- * @param {PROMPT} prompt - The prompt to use for text generation.
- *
- * @returns {Promise<string>} - A promise that resolves to the generated text.
- */
-export declare function generateText<PROMPT>(args: {
-    model: TextGenerationModel<PROMPT, TextGenerationModelSettings>;
-    prompt: PROMPT;
-    fullResponse?: false;
-} & FunctionOptions): Promise<string>;
-export declare function generateText<PROMPT>(args: {
-    model: TextGenerationModel<PROMPT, TextGenerationModelSettings>;
-    prompt: PROMPT;
-    fullResponse: true;
-} & FunctionOptions): Promise<{
-    text: string;
-    finishReason: TextGenerationFinishReason;
-    texts: string[];
-    textGenerationResults: TextGenerationResult[];
-    rawResponse: unknown;
-    metadata: ModelCallMetadata;
-}>;

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

@@ -1,78 +0,0 @@
-import { executeStandardCall } from "../executeStandardCall.js";
-export async function generateText({ model, prompt, fullResponse, ...options }) {
-    const callResponse = await executeStandardCall({
-        functionType: "generate-text",
-        input: prompt,
-        model,
-        options,
-        generateResponse: async (options) => {
-            async function getGeneratedTexts() {
-                if (options?.cache == null) {
-                    return {
-                        ...(await model.doGenerateTexts(prompt, options)),
-                        cache: undefined,
-                    };
-                }
-                let cacheErrors = undefined;
-                const cacheKey = {
-                    functionType: "generate-text",
-                    functionId: options?.functionId,
-                    input: {
-                        model,
-                        settings: model.settingsForEvent, // TODO should include full model information
-                        prompt,
-                    },
-                };
-                try {
-                    const cachedRawResponse = await options.cache.lookupValue(cacheKey);
-                    if (cachedRawResponse != null) {
-                        return {
-                            ...model.restoreGeneratedTexts(cachedRawResponse),
-                            cache: { status: "hit" },
-                        };
-                    }
-                }
-                catch (err) {
-                    cacheErrors = [err];
-                }
-                const result = await model.doGenerateTexts(prompt, options);
-                try {
-                    await options.cache.storeValue(cacheKey, result.rawResponse);
-                }
-                catch (err) {
-                    cacheErrors = [...(cacheErrors ?? []), err];
-                }
-                return {
-                    ...result,
-                    cache: { status: "miss", errors: cacheErrors },
-                };
-            }
-            const result = await getGeneratedTexts();
-            const shouldTrimWhitespace = model.settings.trimWhitespace ?? true;
-            const textGenerationResults = shouldTrimWhitespace
-                ? result.textGenerationResults.map((textGeneration) => ({
-                    text: textGeneration.text.trim(),
-                    finishReason: textGeneration.finishReason,
-                }))
-                : result.textGenerationResults;
-            // TODO add cache information
-            return {
-                rawResponse: result.rawResponse,
-                extractedValue: textGenerationResults,
-                usage: result.usage,
-            };
-        },
-    });
-    const textGenerationResults = callResponse.value;
-    const firstResult = textGenerationResults[0];
-    return fullResponse
-        ? {
-            text: firstResult.text,
-            finishReason: firstResult.finishReason,
-            texts: textGenerationResults.map((textGeneration) => textGeneration.text),
-            textGenerationResults,
-            rawResponse: callResponse.rawResponse,
-            metadata: callResponse.metadata,
-        }
-        : firstResult.text;
-}

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

@@ -1,26 +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("./PromptTemplateFullTextModel.cjs"), exports);
-__exportStar(require("./PromptTemplateTextGenerationModel.cjs"), exports);
-__exportStar(require("./PromptTemplateTextStreamingModel.cjs"), exports);
-__exportStar(require("./TextGenerationEvent.cjs"), exports);
-__exportStar(require("./TextGenerationModel.cjs"), exports);
-__exportStar(require("./TextGenerationPromptTemplate.cjs"), exports);
-__exportStar(require("./TextGenerationResult.cjs"), exports);
-__exportStar(require("./generateText.cjs"), exports);
-__exportStar(require("./prompt-template/index.cjs"), exports);
-__exportStar(require("./streamText.cjs"), exports);

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

@@ -1,10 +0,0 @@
-export * from "./PromptTemplateFullTextModel.js";
-export * from "./PromptTemplateTextGenerationModel.js";
-export * from "./PromptTemplateTextStreamingModel.js";
-export * from "./TextGenerationEvent.js";
-export * from "./TextGenerationModel.js";
-export * from "./TextGenerationPromptTemplate.js";
-export * from "./TextGenerationResult.js";
-export * from "./generateText.js";
-export * from "./prompt-template/index.js";
-export * from "./streamText.js";

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

@@ -1,10 +0,0 @@
-export * from "./PromptTemplateFullTextModel.js";
-export * from "./PromptTemplateTextGenerationModel.js";
-export * from "./PromptTemplateTextStreamingModel.js";
-export * from "./TextGenerationEvent.js";
-export * from "./TextGenerationModel.js";
-export * from "./TextGenerationPromptTemplate.js";
-export * from "./TextGenerationResult.js";
-export * from "./generateText.js";
-export * from "./prompt-template/index.js";
-export * from "./streamText.js";

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.cjs

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = exports.text = void 0;
-const ContentPart_js_1 = require("./ContentPart.cjs");
-const DEFAULT_SYSTEM_PROMPT_INPUT = "Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.";
-const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a task. Write a response that appropriately completes the request.";
-/**
- * Formats a text prompt as an Alpaca prompt.
- */
-function text() {
-    return {
-        stopSequences: [],
-        format(prompt) {
-            let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
-            text += "\n\n### Instruction:\n";
-            text += prompt;
-            text += "\n\n### Response:\n";
-            return text;
-        },
-    };
-}
-exports.text = text;
-/**
- * Formats an instruction prompt as an Alpaca prompt.
- *
- * If the instruction has a system prompt, it overrides the default system prompt
- * (which can impact the results, because the model may be trained on the default system prompt).
- *
- * Prompt template with input:
- * ```
- * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Input:
- *
- * {input}
- *
- * ### Response:
- *
- * ```
- *
- * Prompt template without input:
- * ```
- * Below is an instruction that describes a task. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Response:
- *
- * ```
- *
- * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
- */
-function instruction() {
-    return {
-        stopSequences: [],
-        format(prompt) {
-            let text = prompt.system ??
-                (prompt.input != null
-                    ? DEFAULT_SYSTEM_PROMPT_INPUT
-                    : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
-            text += "\n\n### Instruction:\n";
-            if (prompt.system != null) {
-                text += `${prompt.system}\n`;
-            }
-            text += (0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt);
-            if (prompt.input != null) {
-                text += `\n\n### Input:\n${prompt.input}`;
-            }
-            text += "\n\n### Response:\n";
-            if (prompt.responsePrefix != null) {
-                text += `${prompt.responsePrefix}\n`;
-            }
-            return text;
-        },
-    };
-}
-exports.instruction = instruction;
-/**
- * Not supported by Alpaca.
- */
-function chat() {
-    throw new Error("Chat prompts are not supported by the Alpaca format.");
-}
-exports.chat = chat;

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.d.ts

@@ -1,51 +0,0 @@
-import { TextGenerationPromptTemplate } from "../TextGenerationPromptTemplate.js";
-import { ChatPrompt } from "./ChatPrompt.js";
-import { InstructionPrompt } from "./InstructionPrompt.js";
-/**
- * Formats a text prompt as an Alpaca prompt.
- */
-export declare function text(): TextGenerationPromptTemplate<string, string>;
-/**
- * Formats an instruction prompt as an Alpaca prompt.
- *
- * If the instruction has a system prompt, it overrides the default system prompt
- * (which can impact the results, because the model may be trained on the default system prompt).
- *
- * Prompt template with input:
- * ```
- * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Input:
- *
- * {input}
- *
- * ### Response:
- *
- * ```
- *
- * Prompt template without input:
- * ```
- * Below is an instruction that describes a task. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Response:
- *
- * ```
- *
- * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
- */
-export declare function instruction(): TextGenerationPromptTemplate<InstructionPrompt & {
-    input?: string;
-}, // optional input supported by Alpaca
-string>;
-/**
- * Not supported by Alpaca.
- */
-export declare function chat(): TextGenerationPromptTemplate<ChatPrompt, string>;

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.js

@@ -1,84 +0,0 @@
-import { validateContentIsString } from "./ContentPart.js";
-const DEFAULT_SYSTEM_PROMPT_INPUT = "Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.";
-const DEFAULT_SYSTEM_PROMPT_NO_INPUT = "Below is an instruction that describes a task. Write a response that appropriately completes the request.";
-/**
- * Formats a text prompt as an Alpaca prompt.
- */
-export function text() {
-    return {
-        stopSequences: [],
-        format(prompt) {
-            let text = DEFAULT_SYSTEM_PROMPT_NO_INPUT;
-            text += "\n\n### Instruction:\n";
-            text += prompt;
-            text += "\n\n### Response:\n";
-            return text;
-        },
-    };
-}
-/**
- * Formats an instruction prompt as an Alpaca prompt.
- *
- * If the instruction has a system prompt, it overrides the default system prompt
- * (which can impact the results, because the model may be trained on the default system prompt).
- *
- * Prompt template with input:
- * ```
- * Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Input:
- *
- * {input}
- *
- * ### Response:
- *
- * ```
- *
- * Prompt template without input:
- * ```
- * Below is an instruction that describes a task. Write a response that appropriately completes the request.
- *
- * ### Instruction:
- *
- * {instruction}
- *
- * ### Response:
- *
- * ```
- *
- * @see https://github.com/tatsu-lab/stanford_alpaca#data-release
- */
-export function instruction() {
-    return {
-        stopSequences: [],
-        format(prompt) {
-            let text = prompt.system ??
-                (prompt.input != null
-                    ? DEFAULT_SYSTEM_PROMPT_INPUT
-                    : DEFAULT_SYSTEM_PROMPT_NO_INPUT);
-            text += "\n\n### Instruction:\n";
-            if (prompt.system != null) {
-                text += `${prompt.system}\n`;
-            }
-            text += validateContentIsString(prompt.instruction, prompt);
-            if (prompt.input != null) {
-                text += `\n\n### Input:\n${prompt.input}`;
-            }
-            text += "\n\n### Response:\n";
-            if (prompt.responsePrefix != null) {
-                text += `${prompt.responsePrefix}\n`;
-            }
-            return text;
-        },
-    };
-}
-/**
- * Not supported by Alpaca.
- */
-export function chat() {
-    throw new Error("Chat prompts are not supported by the Alpaca format.");
-}

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.test.cjs

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const AlpacaPromptTemplate_js_1 = require("./AlpacaPromptTemplate.cjs");
-describe("text prompt", () => {
-    it("should format prompt", () => {
-        const prompt = (0, AlpacaPromptTemplate_js_1.text)().format("prompt");
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("instruction prompt", () => {
-    it("should format prompt with instruction", () => {
-        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system and instruction", () => {
-        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
-            system: "system",
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with instruction and response prefix", () => {
-        const prompt = (0, AlpacaPromptTemplate_js_1.instruction)().format({
-            instruction: "instruction",
-            responsePrefix: "response prefix",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.test.d.ts

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

package/model-function/generate-text/prompt-template/AlpacaPromptTemplate.test.js

@@ -1,29 +0,0 @@
-import { instruction, text } from "./AlpacaPromptTemplate.js";
-describe("text prompt", () => {
-    it("should format prompt", () => {
-        const prompt = text().format("prompt");
-        expect(prompt).toMatchSnapshot();
-    });
-});
-describe("instruction prompt", () => {
-    it("should format prompt with instruction", () => {
-        const prompt = instruction().format({
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with system and instruction", () => {
-        const prompt = instruction().format({
-            system: "system",
-            instruction: "instruction",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-    it("should format prompt with instruction and response prefix", () => {
-        const prompt = instruction().format({
-            instruction: "instruction",
-            responsePrefix: "response prefix",
-        });
-        expect(prompt).toMatchSnapshot();
-    });
-});

package/model-function/generate-text/prompt-template/ChatMLPromptTemplate.cjs

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.chat = exports.instruction = exports.text = void 0;
-const ContentPart_js_1 = require("./ContentPart.cjs");
-const InvalidPromptError_js_1 = require("./InvalidPromptError.cjs");
-const START_SEGMENT = "<|im_start|>";
-const END_SEGMENT = "<|im_end|>";
-function segmentStart(role) {
-    return `${START_SEGMENT}${role}\n`;
-}
-function segment(role, text) {
-    return text == null ? "" : `${segmentStart(role)}${text}${END_SEGMENT}\n`;
-}
-/**
- * Formats a text prompt using the ChatML format.
- */
-function text() {
-    return {
-        stopSequences: [END_SEGMENT],
-        format(prompt) {
-            // prompt and then prefix start of assistant response:
-            return segment("user", prompt) + segmentStart("assistant");
-        },
-    };
-}
-exports.text = text;
-/**
- * Formats an instruction prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * ${ system prompt }<|im_end|>
- * <|im_start|>user
- * ${ instruction }<|im_end|>
- * <|im_start|>assistant
- * ${response prefix}
- * ```
- */
-function instruction() {
-    return {
-        stopSequences: [END_SEGMENT],
-        format(prompt) {
-            const instruction = (0, ContentPart_js_1.validateContentIsString)(prompt.instruction, prompt);
-            return (segment("system", prompt.system) +
-                segment("user", instruction) +
-                segmentStart("assistant") +
-                (prompt.responsePrefix ?? ""));
-        },
-    };
-}
-exports.instruction = instruction;
-/**
- * Formats a chat prompt using the ChatML format.
- *
- * ChatML prompt template:
- * ```
- * <|im_start|>system
- * You are a helpful assistant that answers questions about the world.<|im_end|>
- * <|im_start|>user
- * What is the capital of France?<|im_end|>
- * <|im_start|>assistant
- * Paris<|im_end|>
- * ```
- */
-function chat() {
-    return {
-        format(prompt) {
-            let text = prompt.system != null ? segment("system", prompt.system) : "";
-            for (const { role, content } of prompt.messages) {
-                switch (role) {
-                    case "user": {
-                        text += segment("user", (0, ContentPart_js_1.validateContentIsString)(content, prompt));
-                        break;
-                    }
-                    case "assistant": {
-                        text += segment("assistant", (0, ContentPart_js_1.validateContentIsString)(content, prompt));
-                        break;
-                    }
-                    case "tool": {
-                        throw new InvalidPromptError_js_1.InvalidPromptError("Tool messages are not supported.", prompt);
-                    }
-                    default: {
-                        const _exhaustiveCheck = role;
-                        throw new Error(`Unsupported role: ${_exhaustiveCheck}`);
-                    }
-                }
-            }
-            // prefix start of assistant response:
-            text += segmentStart("assistant");
-            return text;
-        },
-        stopSequences: [END_SEGMENT],
-    };
-}
-exports.chat = chat;