modelfusion 0.34.0 → 0.35.1

package/model-provider/openai/chat/OpenAIChatModel.d.ts

@@ -3,10 +3,10 @@ import { ApiConfiguration } from "../../../core/api/ApiConfiguration.js";
 import { ResponseHandler } from "../../../core/api/postToApi.js";
 import { StructureDefinition } from "../../../core/structure/StructureDefinition.js";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
+import { DeltaEvent } from "../../../model-function/DeltaEvent.js";
 import { ModelFunctionOptions } from "../../../model-function/ModelFunctionOptions.js";
 import { StructureGenerationModel } from "../../../model-function/generate-structure/StructureGenerationModel.js";
 import { StructureOrTextGenerationModel } from "../../../model-function/generate-structure/StructureOrTextGenerationModel.js";
-import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../../model-function/generate-text/TextGenerationModel.js";
 import { PromptFormat } from "../../../prompt/PromptFormat.js";
 import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
@@ -132,7 +132,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<Op
  *   ),
  * ]);
  */
-export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, StructureGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatSettings> {
+export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, StructureGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatSettings> {
     constructor(settings: OpenAIChatSettings);
     readonly provider: "openai";
     get modelName(): OpenAIChatModelType;
@@ -185,6 +185,8 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
      */
     generateStructureResponse(structureDefinition: StructureDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: ModelFunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
     extractStructure(response: OpenAIChatResponse): unknown;
+    generateStructureStreamResponse(structureDefinition: StructureDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: ModelFunctionOptions<OpenAIChatSettings>): Promise<AsyncIterable<DeltaEvent<OpenAIChatDelta>>>;
+    extractPartialStructure(fullDelta: OpenAIChatDelta): unknown | undefined;
     generateStructureOrTextResponse(structureDefinitions: Array<StructureDefinition<string, unknown>>, prompt: OpenAIChatMessage[], options?: ModelFunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
     extractStructureAndText(response: OpenAIChatResponse): {
         structure: null;

package/model-provider/openai/chat/OpenAIChatModel.js

@@ -3,6 +3,7 @@ import z from "zod";
 import { callWithRetryAndThrottle } from "../../../core/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../../core/api/postToApi.js";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
+import { parsePartialJson } from "../../../model-function/generate-structure/parsePartialJson.js";
 import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
@@ -255,8 +256,28 @@ export class OpenAIChatModel extends AbstractModel {
         });
     }
     extractStructure(response) {
-        const jsonText = response.choices[0].message.function_call.arguments;
-        return SecureJSON.parse(jsonText);
+        return SecureJSON.parse(response.choices[0].message.function_call.arguments);
+    }
+    generateStructureStreamResponse(structureDefinition, prompt, options) {
+        return this.callAPI(prompt, {
+            responseFormat: OpenAIChatResponseFormat.deltaIterable,
+            functionId: options?.functionId,
+            settings: {
+                ...options,
+                functionCall: { name: structureDefinition.name },
+                functions: [
+                    {
+                        name: structureDefinition.name,
+                        description: structureDefinition.description,
+                        parameters: structureDefinition.schema.getJsonSchema(),
+                    },
+                ],
+            },
+            run: options?.run,
+        });
+    }
+    extractPartialStructure(fullDelta) {
+        return parsePartialJson(fullDelta[0]?.function_call?.arguments);
     }
     generateStructureOrTextResponse(structureDefinitions, prompt, options) {
         return this.callAPI(prompt, {

package/model-provider/openai/chat/OpenAIChatStreamIterable.d.ts

@@ -1,4 +1,4 @@
-import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
+import { DeltaEvent } from "../../../model-function/DeltaEvent.js";
 export type OpenAIChatDelta = Array<{
     role: "assistant" | "user" | undefined;
     content: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "Build multimodal applications, chatbots, and agents with JavaScript and TypeScript.",
-  "version": "0.34.0",
+  "version": "0.35.1",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -47,10 +47,12 @@
     "build": "npm run build:esm && npm run build:cjs",
     "build:esm": "tsc --outDir dist/",
     "build:cjs": "tsc --outDir build/cjs/ -p tsconfig.cjs.json && node bin/prepare-cjs.js",
-    "dist:copy-files": "copyfiles package.json README.md LICENSE dist",
-    "dist": "npm run clean && npm run lint && npm run build && npm run dist:copy-files"
+    "test": "vitest",
+    "dist": "npm run clean && npm run lint && npm run build && npm run dist:copy-files",
+    "dist:copy-files": "copyfiles package.json README.md LICENSE dist"
   },
   "dependencies": {
+    "deep-equal": "2.2.2",
     "eventsource-parser": "1.1.1",
     "js-tiktoken": "1.0.7",
     "nanoid": "3.3.6",
@@ -61,6 +63,7 @@
   "devDependencies": {
     "@pinecone-database/pinecone": "^0.1.6",
     "@tsconfig/recommended": "1.0.3",
+    "@types/deep-equal": "^1.0.2",
     "@types/node": "18.11.9",
     "@typescript-eslint/eslint-plugin": "^6.1.0",
     "@typescript-eslint/parser": "^6.1.0",
@@ -71,7 +74,8 @@
     "lint-staged": "14.0.1",
     "prettier": "3.0.3",
     "rimraf": "5.0.1",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "vitest": "^0.34.5"
   },
   "peerDependencies": {
     "@pinecone-database/pinecone": "0.1.6"

package/prompt/PromptFormatTextGenerationModel.d.ts

@@ -1,5 +1,5 @@
+import { DeltaEvent } from "../model-function/DeltaEvent.js";
 import { ModelFunctionOptions } from "../model-function/ModelFunctionOptions.js";
-import { DeltaEvent } from "../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../model-function/generate-text/TextGenerationModel.js";
 import { PromptFormat } from "./PromptFormat.js";
 export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS extends TextGenerationModelSettings, MODEL extends TextGenerationModel<MODEL_PROMPT, RESPONSE, FULL_DELTA, SETTINGS>> implements TextGenerationModel<PROMPT, RESPONSE, FULL_DELTA, SETTINGS> {

package/tool/useTool.cjs

@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTool = void 0;
 const generateStructure_js_1 = require("../model-function/generate-structure/generateStructure.cjs");
 const executeTool_js_1 = require("./executeTool.cjs");
-// In this file, using 'any' is required to allow for flexibility in the inputs. The actual types are
-// retrieved through lookups such as TOOL["name"], such that any does not affect any client.
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * `useTool` uses `generateStructure` to generate parameters for a tool and then executes the tool with the parameters.
  *
@@ -13,7 +10,9 @@ 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(model, tool, prompt, options) {
+async function useTool(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+model, tool, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tool)

package/tool/useTool.d.ts

@@ -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, SETTINGS>, tool: TOOL, prompt: PROMPT | ((tool: TOOL) => PROMPT), options?: ModelFunctionOptions<SETTINGS>): Promise<{
+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<{
     tool: TOOL["name"];
     parameters: TOOL["inputSchema"];
     result: Awaited<ReturnType<TOOL["execute"]>>;

package/tool/useTool.js

@@ -1,8 +1,5 @@
 import { generateStructure } from "../model-function/generate-structure/generateStructure.js";
 import { executeTool } from "./executeTool.js";
-// In this file, using 'any' is required to allow for flexibility in the inputs. The actual types are
-// retrieved through lookups such as TOOL["name"], such that any does not affect any client.
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * `useTool` uses `generateStructure` to generate parameters for a tool and then executes the tool with the parameters.
  *
@@ -10,7 +7,9 @@ import { executeTool } from "./executeTool.js";
  * the parameters (`parameters` property, typed),
  * and the result of the tool execution (`result` property, typed).
  */
-export async function useTool(model, tool, prompt, options) {
+export async function useTool(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+model, tool, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tool)

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

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractTextDeltas = void 0;
-async function* extractTextDeltas({ deltaIterable, extractDelta, onDone, onError, }) {
-    let accumulatedText = "";
-    let lastFullDelta;
-    for await (const event of deltaIterable) {
-        if (event?.type === "error") {
-            onError(event.error);
-            throw event.error;
-        }
-        if (event?.type === "delta") {
-            lastFullDelta = event.fullDelta;
-            const delta = extractDelta(lastFullDelta);
-            if (delta != null && delta.length > 0) {
-                accumulatedText += delta;
-                yield delta;
-            }
-        }
-    }
-    onDone(accumulatedText, lastFullDelta);
-}
-exports.extractTextDeltas = extractTextDeltas;

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

@@ -1,7 +0,0 @@
-import { DeltaEvent } from "./DeltaEvent.js";
-export declare function extractTextDeltas<FULL_DELTA>({ deltaIterable, extractDelta, onDone, onError, }: {
-    deltaIterable: AsyncIterable<DeltaEvent<FULL_DELTA>>;
-    extractDelta: (fullDelta: FULL_DELTA) => string | undefined;
-    onDone: (fullText: string, lastFullDelta: FULL_DELTA | undefined) => void;
-    onError: (error: unknown) => void;
-}): AsyncIterable<string>;

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

@@ -1,19 +0,0 @@
-export async function* extractTextDeltas({ deltaIterable, extractDelta, onDone, onError, }) {
-    let accumulatedText = "";
-    let lastFullDelta;
-    for await (const event of deltaIterable) {
-        if (event?.type === "error") {
-            onError(event.error);
-            throw event.error;
-        }
-        if (event?.type === "delta") {
-            lastFullDelta = event.fullDelta;
-            const delta = extractDelta(lastFullDelta);
-            if (delta != null && delta.length > 0) {
-                accumulatedText += delta;
-                yield delta;
-            }
-        }
-    }
-    onDone(accumulatedText, lastFullDelta);
-}