modelfusion 0.106.0 → 0.108.0

package/model-provider/openai-compatible/OpenAICompatibleFacade.cjs

@@ -1,7 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatTextGenerator = void 0;
+exports.ChatTextGenerator = exports.CompletionTextGenerator = void 0;
 const OpenAICompatibleChatModel_js_1 = require("./OpenAICompatibleChatModel.cjs");
+const OpenAICompatibleCompletionModel_js_1 = require("./OpenAICompatibleCompletionModel.cjs");
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's completion API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * ```ts
+ * const model = openaicompatible.CompletionTextGenerator({
+ *   model: "provider-specific-model-name",
+ *   temperature: 0.7,
+ *   maxGenerationTokens: 500,
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:"
+ * );
+ * ```
+ */
+function CompletionTextGenerator(settings) {
+    return new OpenAICompatibleCompletionModel_js_1.OpenAICompatibleCompletionModel(settings);
+}
+exports.CompletionTextGenerator = CompletionTextGenerator;
 /**
  * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
  *
@@ -11,18 +38,22 @@ const OpenAICompatibleChatModel_js_1 = require("./OpenAICompatibleChatModel.cjs"
  * @see https://platform.openai.com/docs/api-reference/chat/create
  *
  * @example
+ * ```ts
  * const model = openaicompatible.ChatTextGenerator({
  *   model: "provider-specific-model-name",
  *   temperature: 0.7,
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText([
+ * const text = await generateText(
  *   model,
- *   openai.ChatMessage.system(
- *     "Write a short story about a robot learning to love:"
- *   ),
- * ]);
+ *   [
+ *     openai.ChatMessage.user(
+ *       "Write a short story about a robot learning to love:"
+ *     ),
+ *   ]
+ * );
+ * ```
  */
 function ChatTextGenerator(settings) {
     return new OpenAICompatibleChatModel_js_1.OpenAICompatibleChatModel(settings);

package/model-provider/openai-compatible/OpenAICompatibleFacade.d.ts

@@ -1,4 +1,28 @@
 import { OpenAICompatibleChatModel, OpenAICompatibleChatSettings } from "./OpenAICompatibleChatModel.js";
+import { OpenAICompatibleCompletionModel } from "./OpenAICompatibleCompletionModel.js";
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's completion API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * ```ts
+ * const model = openaicompatible.CompletionTextGenerator({
+ *   model: "provider-specific-model-name",
+ *   temperature: 0.7,
+ *   maxGenerationTokens: 500,
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:"
+ * );
+ * ```
+ */
+export declare function CompletionTextGenerator(settings: OpenAICompatibleChatSettings): OpenAICompatibleCompletionModel;
 /**
  * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
  *
@@ -8,17 +32,21 @@ import { OpenAICompatibleChatModel, OpenAICompatibleChatSettings } from "./OpenA
  * @see https://platform.openai.com/docs/api-reference/chat/create
  *
  * @example
+ * ```ts
  * const model = openaicompatible.ChatTextGenerator({
  *   model: "provider-specific-model-name",
  *   temperature: 0.7,
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText([
+ * const text = await generateText(
  *   model,
- *   openai.ChatMessage.system(
- *     "Write a short story about a robot learning to love:"
- *   ),
- * ]);
+ *   [
+ *     openai.ChatMessage.user(
+ *       "Write a short story about a robot learning to love:"
+ *     ),
+ *   ]
+ * );
+ * ```
  */
 export declare function ChatTextGenerator(settings: OpenAICompatibleChatSettings): OpenAICompatibleChatModel;

package/model-provider/openai-compatible/OpenAICompatibleFacade.js

@@ -1,4 +1,30 @@
 import { OpenAICompatibleChatModel, } from "./OpenAICompatibleChatModel.js";
+import { OpenAICompatibleCompletionModel } from "./OpenAICompatibleCompletionModel.js";
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's completion API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ *
+ * @example
+ * ```ts
+ * const model = openaicompatible.CompletionTextGenerator({
+ *   model: "provider-specific-model-name",
+ *   temperature: 0.7,
+ *   maxGenerationTokens: 500,
+ * });
+ *
+ * const text = await generateText(
+ *   model,
+ *   "Write a short story about a robot learning to love:"
+ * );
+ * ```
+ */
+export function CompletionTextGenerator(settings) {
+    return new OpenAICompatibleCompletionModel(settings);
+}
 /**
  * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
  *
@@ -8,18 +34,22 @@ import { OpenAICompatibleChatModel, } from "./OpenAICompatibleChatModel.js";
  * @see https://platform.openai.com/docs/api-reference/chat/create
  *
  * @example
+ * ```ts
  * const model = openaicompatible.ChatTextGenerator({
  *   model: "provider-specific-model-name",
  *   temperature: 0.7,
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText([
+ * const text = await generateText(
  *   model,
- *   openai.ChatMessage.system(
- *     "Write a short story about a robot learning to love:"
- *   ),
- * ]);
+ *   [
+ *     openai.ChatMessage.user(
+ *       "Write a short story about a robot learning to love:"
+ *     ),
+ *   ]
+ * );
+ * ```
  */
 export function ChatTextGenerator(settings) {
     return new OpenAICompatibleChatModel(settings);

package/model-provider/openai-compatible/OpenAICompatibleProviderName.cjs

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

package/model-provider/openai-compatible/OpenAICompatibleProviderName.d.ts

@@ -0,0 +1 @@
+export type OpenAICompatibleProviderName = `openaicompatible` | `openaicompatible-${string}`;

package/model-provider/openai-compatible/OpenAICompatibleProviderName.js

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

package/model-provider/openai-compatible/TogetherAIApiConfiguration.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TogetherAIApiConfiguration = void 0;
+const BaseUrlApiConfiguration_js_1 = require("../../core/api/BaseUrlApiConfiguration.cjs");
+const loadApiKey_js_1 = require("../../core/api/loadApiKey.cjs");
+/**
+ * Configuration for the Together.ai API.
+ *
+ * It uses the `TOGETHER_API_KEY` api key environment variable.
+ *
+ * @see https://docs.together.ai/docs/openai-api-compatibility
+ */
+class TogetherAIApiConfiguration extends BaseUrlApiConfiguration_js_1.BaseUrlApiConfiguration {
+    constructor({ baseUrl = "https://api.together.xyz/v1", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            headers: {
+                Authorization: `Bearer ${(0, loadApiKey_js_1.loadApiKey)({
+                    apiKey,
+                    environmentVariableName: "TOGETHER_API_KEY",
+                    description: "Together AI",
+                })}`,
+            },
+            retry,
+            throttle,
+        });
+    }
+}
+exports.TogetherAIApiConfiguration = TogetherAIApiConfiguration;

package/model-provider/openai-compatible/TogetherAIApiConfiguration.d.ts

@@ -0,0 +1,18 @@
+import { BaseUrlApiConfiguration } from "../../core/api/BaseUrlApiConfiguration.js";
+import { RetryFunction } from "../../core/api/RetryFunction.js";
+import { ThrottleFunction } from "../../core/api/ThrottleFunction.js";
+/**
+ * Configuration for the Together.ai API.
+ *
+ * It uses the `TOGETHER_API_KEY` api key environment variable.
+ *
+ * @see https://docs.together.ai/docs/openai-api-compatibility
+ */
+export declare class TogetherAIApiConfiguration extends BaseUrlApiConfiguration {
+    constructor({ baseUrl, apiKey, retry, throttle, }?: {
+        baseUrl?: string;
+        apiKey?: string;
+        retry?: RetryFunction;
+        throttle?: ThrottleFunction;
+    });
+}

package/model-provider/openai-compatible/TogetherAIApiConfiguration.js

@@ -0,0 +1,25 @@
+import { BaseUrlApiConfiguration } from "../../core/api/BaseUrlApiConfiguration.js";
+import { loadApiKey } from "../../core/api/loadApiKey.js";
+/**
+ * Configuration for the Together.ai API.
+ *
+ * It uses the `TOGETHER_API_KEY` api key environment variable.
+ *
+ * @see https://docs.together.ai/docs/openai-api-compatibility
+ */
+export class TogetherAIApiConfiguration extends BaseUrlApiConfiguration {
+    constructor({ baseUrl = "https://api.together.xyz/v1", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            headers: {
+                Authorization: `Bearer ${loadApiKey({
+                    apiKey,
+                    environmentVariableName: "TOGETHER_API_KEY",
+                    description: "Together AI",
+                })}`,
+            },
+            retry,
+            throttle,
+        });
+    }
+}

package/model-provider/openai-compatible/index.cjs

@@ -27,6 +27,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.openaicompatible = void 0;
+__exportStar(require("./FireworksAIApiConfiguration.cjs"), exports);
 __exportStar(require("./OpenAICompatibleChatModel.cjs"), exports);
+__exportStar(require("./OpenAICompatibleCompletionModel.cjs"), exports);
 exports.openaicompatible = __importStar(require("./OpenAICompatibleFacade.cjs"));
-__exportStar(require("./FireworksAIApiConfiguration.cjs"), exports);
+__exportStar(require("./OpenAICompatibleProviderName.cjs"), exports);
+__exportStar(require("./TogetherAIApiConfiguration.cjs"), exports);

package/model-provider/openai-compatible/index.d.ts

@@ -1,3 +1,6 @@
+export * from "./FireworksAIApiConfiguration.js";
 export * from "./OpenAICompatibleChatModel.js";
+export * from "./OpenAICompatibleCompletionModel.js";
 export * as openaicompatible from "./OpenAICompatibleFacade.js";
-export * from "./FireworksAIApiConfiguration.js";
+export * from "./OpenAICompatibleProviderName.js";
+export * from "./TogetherAIApiConfiguration.js";

package/model-provider/openai-compatible/index.js

@@ -1,3 +1,6 @@
+export * from "./FireworksAIApiConfiguration.js";
 export * from "./OpenAICompatibleChatModel.js";
+export * from "./OpenAICompatibleCompletionModel.js";
 export * as openaicompatible from "./OpenAICompatibleFacade.js";
-export * from "./FireworksAIApiConfiguration.js";
+export * from "./OpenAICompatibleProviderName.js";
+export * from "./TogetherAIApiConfiguration.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building multi-modal AI applications.",
-  "version": "0.106.0",
+  "version": "0.108.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -48,20 +48,6 @@
       "require": "./extension/index.cjs"
     }
   },
-  "scripts": {
-    "lint": "eslint --ext .ts src",
-    "clean": "rimraf build dist .turbo node_modules",
-    "clean:build": "rimraf build dist",
-    "build": "pnpm build:esm && pnpm build:cjs && pnpm build:copy-files",
-    "build:esm": "tsc --outDir dist/",
-    "build:cjs": "tsc --outDir build/cjs/ -p tsconfig.cjs.json && node bin/prepare-cjs.js",
-    "build:copy-files": "copyfiles --flat package.json ../../README.md ../../LICENSE ../../CHANGELOG.md dist",
-    "test": "vitest --config vitest.config.js --run src",
-    "test:watch": "vitest watch --config vitest.config.js",
-    "test:coverage": "vitest run --config vitest.config.js --coverage",
-    "test:coverage:ui": "vitest --config vitest.config.js --coverage --ui",
-    "dist": "pnpm clean:build && pnpm lint && pnpm test && pnpm build"
-  },
   "dependencies": {
     "eventsource-parser": "1.1.1",
     "js-tiktoken": "1.0.7",
@@ -81,5 +67,19 @@
     "eslint": "^8.45.0",
     "eslint-config-prettier": "9.1.0",
     "msw": "2.0.11"
+  },
+  "scripts": {
+    "lint": "eslint --ext .ts src",
+    "clean": "rimraf build dist .turbo node_modules",
+    "clean:build": "rimraf build dist",
+    "build": "pnpm build:esm && pnpm build:cjs && pnpm build:copy-files",
+    "build:esm": "tsc --outDir dist/",
+    "build:cjs": "tsc --outDir build/cjs/ -p tsconfig.cjs.json && node bin/prepare-cjs.js",
+    "build:copy-files": "copyfiles --flat package.json ../../README.md ../../LICENSE ../../CHANGELOG.md dist",
+    "test": "vitest --config vitest.config.js --run src",
+    "test:watch": "vitest watch --config vitest.config.js",
+    "test:coverage": "vitest run --config vitest.config.js --coverage",
+    "test:coverage:ui": "vitest --config vitest.config.js --coverage --ui",
+    "dist": "pnpm clean:build && pnpm lint && pnpm test && pnpm build"
   }
-}
+}

package/tool/generate-tool-call/index.cjs

@@ -19,3 +19,4 @@ __exportStar(require("./ToolCallGenerationEvent.cjs"), exports);
 __exportStar(require("./ToolCallGenerationModel.cjs"), exports);
 __exportStar(require("./ToolCallParseError.cjs"), exports);
 __exportStar(require("./generateToolCall.cjs"), exports);
+__exportStar(require("./jsonToolCallPrompt.cjs"), exports);

package/tool/generate-tool-call/index.d.ts

@@ -3,3 +3,4 @@ export * from "./ToolCallGenerationEvent.js";
 export * from "./ToolCallGenerationModel.js";
 export * from "./ToolCallParseError.js";
 export * from "./generateToolCall.js";
+export * from "./jsonToolCallPrompt.js";

package/tool/generate-tool-call/index.js

@@ -3,3 +3,4 @@ export * from "./ToolCallGenerationEvent.js";
 export * from "./ToolCallGenerationModel.js";
 export * from "./ToolCallParseError.js";
 export * from "./generateToolCall.js";
+export * from "./jsonToolCallPrompt.js";

package/tool/generate-tool-call/jsonToolCallPrompt.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonToolCallPrompt = void 0;
+const nanoid_1 = require("nanoid");
+const parseJSON_js_1 = require("../../core/schema/parseJSON.cjs");
+exports.jsonToolCallPrompt = {
+    text() {
+        return {
+            createPrompt(instruction, tool) {
+                return {
+                    system: [
+                        `You are calling a function "${tool.name}".`,
+                        tool.description != null
+                            ? `  Function description: ${tool.description}`
+                            : null,
+                        `  Function parameters JSON schema: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                        ``,
+                        `You MUST answer with a JSON object matches the above schema for the arguments.`,
+                    ]
+                        .filter(Boolean)
+                        .join("\n"),
+                    instruction,
+                };
+            },
+            extractToolCall(response) {
+                return { id: (0, nanoid_1.nanoid)(), args: (0, parseJSON_js_1.parseJSON)({ text: response }) };
+            },
+        };
+    },
+};

package/tool/generate-tool-call/jsonToolCallPrompt.d.ts

@@ -0,0 +1,5 @@
+import { InstructionPrompt } from "../../model-function/generate-text/prompt-template/InstructionPrompt.js";
+import { ToolCallPromptTemplate } from "./TextGenerationToolCallModel.js";
+export declare const jsonToolCallPrompt: {
+    text(): ToolCallPromptTemplate<string, InstructionPrompt>;
+};

package/tool/generate-tool-call/jsonToolCallPrompt.js

@@ -0,0 +1,27 @@
+import { nanoid } from "nanoid";
+import { parseJSON } from "../../core/schema/parseJSON.js";
+export const jsonToolCallPrompt = {
+    text() {
+        return {
+            createPrompt(instruction, tool) {
+                return {
+                    system: [
+                        `You are calling a function "${tool.name}".`,
+                        tool.description != null
+                            ? `  Function description: ${tool.description}`
+                            : null,
+                        `  Function parameters JSON schema: ${JSON.stringify(tool.parameters.getJsonSchema())}`,
+                        ``,
+                        `You MUST answer with a JSON object matches the above schema for the arguments.`,
+                    ]
+                        .filter(Boolean)
+                        .join("\n"),
+                    instruction,
+                };
+            },
+            extractToolCall(response) {
+                return { id: nanoid(), args: parseJSON({ text: response }) };
+            },
+        };
+    },
+};