modelfusion 0.40.0 → 0.41.0

package/prompt/PromptFormatTextStreamingModel.js

@@ -0,0 +1,27 @@
+import { PromptFormatTextGenerationModel } from "./PromptFormatTextGenerationModel.js";
+export class PromptFormatTextStreamingModel extends PromptFormatTextGenerationModel {
+    constructor(options) {
+        super(options);
+    }
+    doStreamText(prompt, options) {
+        const mappedPrompt = this.promptFormat.format(prompt);
+        return this.model.doStreamText(mappedPrompt, options);
+    }
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextStreamingModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptFormat.stopSequences,
+                ],
+            }),
+            promptFormat,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new PromptFormatTextStreamingModel({
+            model: this.model.withSettings(additionalSettings),
+            promptFormat: this.promptFormat,
+        });
+    }
+}

package/prompt/chat/trimChatPrompt.d.ts

@@ -1,4 +1,4 @@
-import { TextGenerationModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
 import { ChatPrompt } from "./ChatPrompt.js";
 /**
  * Keeps only the most recent messages in the prompt, while leaving enough space for the completion.
@@ -12,7 +12,7 @@ import { ChatPrompt } from "./ChatPrompt.js";
  */
 export declare function trimChatPrompt({ prompt, model, tokenLimit, }: {
     prompt: ChatPrompt;
-    model: TextGenerationModel<ChatPrompt, any, any, any> & {
+    model: TextGenerationModel<ChatPrompt, TextGenerationModelSettings> & {
         contextWindowSize: number;
         countPromptTokens: (prompt: ChatPrompt) => PromiseLike<number>;
     };

package/prompt/index.cjs

@@ -19,6 +19,7 @@ __exportStar(require("./InstructionPrompt.cjs"), exports);
 __exportStar(require("./Llama2PromptFormat.cjs"), exports);
 __exportStar(require("./PromptFormat.cjs"), exports);
 __exportStar(require("./PromptFormatTextGenerationModel.cjs"), exports);
+__exportStar(require("./PromptFormatTextStreamingModel.cjs"), exports);
 __exportStar(require("./TextPromptFormat.cjs"), exports);
 __exportStar(require("./VicunaPromptFormat.cjs"), exports);
 __exportStar(require("./chat/ChatPrompt.cjs"), exports);

package/prompt/index.d.ts

@@ -3,6 +3,7 @@ export * from "./InstructionPrompt.js";
 export * from "./Llama2PromptFormat.js";
 export * from "./PromptFormat.js";
 export * from "./PromptFormatTextGenerationModel.js";
+export * from "./PromptFormatTextStreamingModel.js";
 export * from "./TextPromptFormat.js";
 export * from "./VicunaPromptFormat.js";
 export * from "./chat/ChatPrompt.js";

package/prompt/index.js

@@ -3,6 +3,7 @@ export * from "./InstructionPrompt.js";
 export * from "./Llama2PromptFormat.js";
 export * from "./PromptFormat.js";
 export * from "./PromptFormatTextGenerationModel.js";
+export * from "./PromptFormatTextStreamingModel.js";
 export * from "./TextPromptFormat.js";
 export * from "./VicunaPromptFormat.js";
 export * from "./chat/ChatPrompt.js";

package/retriever/Retriever.d.ts

@@ -1,7 +1,4 @@
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-export interface RetrieverSettings {
-}
-export interface Retriever<OBJECT, QUERY, SETTINGS extends RetrieverSettings> {
-    retrieve(query: QUERY, options?: ModelFunctionOptions<RetrieverSettings>): Promise<OBJECT[]>;
-    withSettings(additionalSettings: Partial<SETTINGS>): this;
+import { FunctionOptions } from "core";
+export interface Retriever<OBJECT, QUERY> {
+    retrieve(query: QUERY, options?: FunctionOptions): Promise<OBJECT[]>;
 }

package/retriever/retrieve.cjs

@@ -69,9 +69,9 @@ async function retrieve(retriever, query, options) {
         eventType: "finished",
         result: {
             status: "success",
-            output: result.output,
+            value: result.value,
         },
     });
-    return result.output;
+    return result.value;
 }
 exports.retrieve = retrieve;

package/retriever/retrieve.d.ts

@@ -1,3 +1,3 @@
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-import { Retriever, RetrieverSettings } from "./Retriever.js";
-export declare function retrieve<OBJECT, QUERY, SETTINGS extends RetrieverSettings>(retriever: Retriever<OBJECT, QUERY, SETTINGS>, query: QUERY, options?: ModelFunctionOptions<SETTINGS>): Promise<OBJECT[]>;
+import { FunctionOptions } from "../core/FunctionOptions.js";
+import { Retriever } from "./Retriever.js";
+export declare function retrieve<OBJECT, QUERY>(retriever: Retriever<OBJECT, QUERY>, query: QUERY, options?: FunctionOptions): Promise<OBJECT[]>;

package/retriever/retrieve.js

@@ -66,8 +66,8 @@ export async function retrieve(retriever, query, options) {
         eventType: "finished",
         result: {
             status: "success",
-            output: result.output,
+            value: result.value,
         },
     });
-    return result.output;
+    return result.value;
 }

package/tool/executeTool.cjs

@@ -115,12 +115,12 @@ async function doExecuteTool(tool, input, options) {
             message: result.error?.message,
         });
     }
-    const output = result.output;
+    const output = result.value;
     eventSource.notify({
         ...finishMetadata,
         result: {
             status: "success",
-            output,
+            value: output,
         },
     });
     return {

package/tool/executeTool.js

@@ -110,12 +110,12 @@ async function doExecuteTool(tool, input, options) {
             message: result.error?.message,
         });
     }
-    const output = result.output;
+    const output = result.value;
     eventSource.notify({
         ...finishMetadata,
         result: {
             status: "success",
-            output,
+            value: output,
         },
     });
     return {

package/tool/useTool.cjs

@@ -10,14 +10,12 @@ const executeTool_js_1 = require("./executeTool.cjs");
  * the parameters (`parameters` property, typed),
  * and the result of the tool execution (`result` property, typed).
  */
-async function useTool(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-model, tool, prompt, options) {
+async function useTool(model, tool, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tool)
         : prompt;
-    const { output: value } = await (0, generateStructure_js_1.generateStructure)(model, {
+    const { value } = await (0, generateStructure_js_1.generateStructure)(model, {
         name: tool.name,
         description: tool.description,
         schema: tool.inputSchema,

package/tool/useTool.d.ts

@@ -1,4 +1,4 @@
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
+import { FunctionOptions } from "../core/FunctionOptions.js";
 import { StructureGenerationModel, StructureGenerationModelSettings } from "../model-function/generate-structure/StructureGenerationModel.js";
 import { Tool } from "./Tool.js";
 /**
@@ -8,7 +8,7 @@ import { Tool } from "./Tool.js";
  * the parameters (`parameters` property, typed),
  * and the result of the tool execution (`result` property, typed).
  */
-export declare function useTool<PROMPT, RESPONSE, SETTINGS extends StructureGenerationModelSettings, TOOL extends Tool<any, any, any>>(model: StructureGenerationModel<PROMPT, RESPONSE, any, SETTINGS>, tool: TOOL, prompt: PROMPT | ((tool: TOOL) => PROMPT), options?: ModelFunctionOptions<SETTINGS>): Promise<{
+export declare function useTool<PROMPT, TOOL extends Tool<any, any, any>>(model: StructureGenerationModel<PROMPT, StructureGenerationModelSettings>, tool: TOOL, prompt: PROMPT | ((tool: TOOL) => PROMPT), options?: FunctionOptions): Promise<{
     tool: TOOL["name"];
     parameters: TOOL["inputSchema"];
     result: Awaited<ReturnType<TOOL["execute"]>>;

package/tool/useTool.js

@@ -7,14 +7,12 @@ import { executeTool } from "./executeTool.js";
  * the parameters (`parameters` property, typed),
  * and the result of the tool execution (`result` property, typed).
  */
-export async function useTool(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-model, tool, prompt, options) {
+export async function useTool(model, tool, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tool)
         : prompt;
-    const { output: value } = await generateStructure(model, {
+    const { value } = await generateStructure(model, {
         name: tool.name,
         description: tool.description,
         schema: tool.inputSchema,

package/tool/useToolOrGenerateText.d.ts

@@ -1,4 +1,4 @@
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
+import { FunctionOptions } from "../core/FunctionOptions.js";
 import { StructureOrTextGenerationModel, StructureOrTextGenerationModelSettings } from "../model-function/generate-structure/StructureOrTextGenerationModel.js";
 import { Tool } from "./Tool.js";
 type ToolArray<T extends Tool<any, any, any>[]> = T;
@@ -14,7 +14,7 @@ type ToToolUnion<T> = {
     } : never;
 }[keyof T];
 type ToOutputValue<TOOLS extends ToolArray<Tool<any, any, any>[]>> = ToToolUnion<ToToolMap<TOOLS>>;
-export declare function useToolOrGenerateText<PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings, TOOLS extends Array<Tool<any, any, any>>>(model: StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: ModelFunctionOptions<SETTINGS>): Promise<{
+export declare function useToolOrGenerateText<PROMPT, SETTINGS extends StructureOrTextGenerationModelSettings, TOOLS extends Array<Tool<any, any, any>>>(model: StructureOrTextGenerationModel<PROMPT, SETTINGS>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: FunctionOptions): Promise<{
     tool: null;
     parameters: null;
     result: null;

package/util/SafeResult.d.ts

@@ -1,6 +1,6 @@
 export type SafeResult<OUTPUT> = {
     ok: true;
-    output: OUTPUT;
+    value: OUTPUT;
 } | {
     ok: false;
     isAborted?: boolean;

package/util/runSafe.cjs

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runSafe = void 0;
 const runSafe = async (f) => {
     try {
-        return { ok: true, output: await f() };
+        return { ok: true, value: await f() };
     }
     catch (error) {
         if (error instanceof Error && error.name === "AbortError") {

package/util/runSafe.js

@@ -1,6 +1,6 @@
 export const runSafe = async (f) => {
     try {
-        return { ok: true, output: await f() };
+        return { ok: true, value: await f() };
     }
     catch (error) {
         if (error instanceof Error && error.name === "AbortError") {

package/vector-index/VectorIndexRetriever.cjs

@@ -31,13 +31,6 @@ class VectorIndexRetriever {
         };
     }
     async retrieve(query, options) {
-        if (options?.settings != null) {
-            return this.withSettings(options.settings).retrieve(query, {
-                functionId: options.functionId,
-                observers: options.observers,
-                run: options.run,
-            });
-        }
         const embedding = await (0, embed_js_1.embed)(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,

package/vector-index/VectorIndexRetriever.d.ts

@@ -1,20 +1,20 @@
+import { FunctionOptions } from "../core/FunctionOptions.js";
 import { EmbeddingModel, EmbeddingModelSettings } from "../model-function/embed/EmbeddingModel.js";
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-import { Retriever, RetrieverSettings } from "../retriever/Retriever.js";
+import { Retriever } from "../retriever/Retriever.js";
 import { VectorIndex } from "./VectorIndex.js";
 export interface VectorIndexRetrieverSettings<FILTER> {
     maxResults?: number;
     similarityThreshold?: number;
     filter?: FILTER;
 }
-export declare class VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER> implements Retriever<OBJECT, VALUE, VectorIndexRetrieverSettings<FILTER>> {
+export declare class VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER> implements Retriever<OBJECT, VALUE> {
     private readonly vectorIndex;
     private readonly embeddingModel;
     private readonly settings;
     constructor({ vectorIndex, embeddingModel, maxResults, similarityThreshold, filter, }: {
         vectorIndex: VectorIndex<OBJECT, INDEX, FILTER>;
-        embeddingModel: EmbeddingModel<VALUE, unknown, EmbeddingModelSettings>;
+        embeddingModel: EmbeddingModel<VALUE, EmbeddingModelSettings>;
     } & VectorIndexRetrieverSettings<FILTER>);
-    retrieve(query: VALUE, options?: ModelFunctionOptions<RetrieverSettings>): Promise<OBJECT[]>;
+    retrieve(query: VALUE, options?: FunctionOptions): Promise<OBJECT[]>;
     withSettings(additionalSettings: Partial<VectorIndexRetrieverSettings<FILTER>>): this;
 }

package/vector-index/VectorIndexRetriever.js

@@ -28,13 +28,6 @@ export class VectorIndexRetriever {
         };
     }
     async retrieve(query, options) {
-        if (options?.settings != null) {
-            return this.withSettings(options.settings).retrieve(query, {
-                functionId: options.functionId,
-                observers: options.observers,
-                run: options.run,
-            });
-        }
         const embedding = await embed(this.embeddingModel, query, {
             functionId: options?.functionId,
             run: options?.run,

package/vector-index/upsertIntoVectorIndex.d.ts

@@ -1,11 +1,11 @@
-import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
+import { FunctionOptions } from "../core/FunctionOptions.js";
 import { EmbeddingModel, EmbeddingModelSettings } from "../model-function/embed/EmbeddingModel.js";
 import { VectorIndex } from "./VectorIndex.js";
-export declare function upsertIntoVectorIndex<VALUE, OBJECT, SETTINGS extends EmbeddingModelSettings>({ vectorIndex, embeddingModel, generateId, objects, getValueToEmbed, getId, }: {
+export declare function upsertIntoVectorIndex<VALUE, OBJECT>({ vectorIndex, embeddingModel, generateId, objects, getValueToEmbed, getId, }: {
     vectorIndex: VectorIndex<OBJECT, unknown, unknown>;
-    embeddingModel: EmbeddingModel<VALUE, unknown, SETTINGS>;
+    embeddingModel: EmbeddingModel<VALUE, EmbeddingModelSettings>;
     generateId?: () => string;
     objects: OBJECT[];
     getValueToEmbed: (object: OBJECT, index: number) => VALUE;
     getId?: (object: OBJECT, index: number) => string | undefined;
-}, options?: ModelFunctionOptions<SETTINGS>): Promise<void>;
+}, options?: FunctionOptions): Promise<void>;

package/model-function/DeltaEvent.d.ts

@@ -1,7 +0,0 @@
-export type DeltaEvent<FULL_DELTA> = {
-    type: "delta";
-    fullDelta: FULL_DELTA;
-} | {
-    type: "error";
-    error: unknown;
-};

package/model-function/ModelFunctionOptions.d.ts

@@ -1,4 +0,0 @@
-import { FunctionOptions } from "../core/FunctionOptions.js";
-export interface ModelFunctionOptions<SETTINGS> extends FunctionOptions {
-    settings?: Partial<SETTINGS>;
-}