modelfusion 0.131.0 → 0.132.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v0.132.0 - 2024-02-15
+
+### Added
+
+- Support for OpenAI `text-embedding-3-small` and `text-embedding-3-large` embedding models.
+- Support for OpenAI `gpt-4-turbo-preview`, `gpt-4-0125-preview`, and `gpt-3.5-turbo-0125` chat models.
+
+## v0.131.1 - 2024-01-25
+
+### Fixed
+
+- Add `type-fest` as dependency to fix type inference errors.
+
 ## v0.131.0 - 2024-01-23
 
 ### Added

package/README.md

@@ -7,6 +7,7 @@
 [![Docs](https://img.shields.io/badge/docs-modelfusion.dev-blue)](https://modelfusion.dev)
 [![Discord](https://discordapp.com/api/guilds/1136309340740006029/widget.png?style=shield)](https://discord.gg/GqCwYZATem)
 [![Created by Lars Grammel](https://img.shields.io/badge/created%20by-@lgrammel-4BBAAB.svg)](https://twitter.com/lgrammel)
+[![Follow @modelfusionjs](https://img.shields.io/badge/follow-@modelfusionjs-4BBAAB.svg)](https://twitter.com/modelfusionjs)
 
 [Introduction](#introduction) | [Quick Install](#quick-install) | [Usage](#usage-examples) | [Documentation](#documentation) | [Examples](#more-examples) | [Contributing](#contributing) | [modelfusion.dev](https://modelfusion.dev)
 
@@ -30,7 +31,7 @@
 npm install modelfusion
 ```
 
-Or use a start template:
+Or use a starter template:
 
 - [ModelFusion terminal app starter](https://github.com/lgrammel/modelfusion-terminal-app-starter)
 - [Next.js, Vercel AI SDK, Llama.cpp & ModelFusion starter](https://github.com/lgrammel/modelfusion-llamacpp-nextjs-starter)
@@ -578,7 +579,7 @@ const text = await generateText({
   - [Generate object](https://modelfusion.dev/guide/function/generate-object)
   - [Generate image](https://modelfusion.dev/guide/function/generate-image)
   - [Generate speech](https://modelfusion.dev/guide/function/generate-speech)
-  - [Generate transcription](https://modelfusion.dev/guide/function/generation-transcription)
+  - [Generate transcription](https://modelfusion.dev/guide/function/generate-transcription)
   - [Tokenize Text](https://modelfusion.dev/guide/function/tokenize-text)
   - [Embed Value](https://modelfusion.dev/guide/function/embed)
   - [Classify Value](https://modelfusion.dev/guide/function/classify)

package/core/getRun.cjs

@@ -24,16 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRun = exports.getRun = void 0;
+const detectRuntime_js_1 = require("../util/detectRuntime.cjs");
 let runStorage;
 async function ensureLoaded() {
-    // Note: using process[versions] instead of process.versions to avoid Next.js edge runtime warnings.
-    const versions = "versions";
-    const isNode = typeof process !== "undefined" &&
-        process[versions] != null &&
-        process[versions].node != null;
-    if (!isNode)
-        return Promise.resolve();
-    if (!runStorage) {
+    if ((0, detectRuntime_js_1.detectRuntime)() === "node" && !runStorage) {
         // Note: using "async_hooks" instead of "node:async_hooks" to avoid webpack fallback problems.
         const { AsyncLocalStorage } = await Promise.resolve().then(() => __importStar(require("async_hooks")));
         runStorage = new AsyncLocalStorage();

package/core/getRun.d.ts

@@ -1,4 +1,4 @@
-import { Run } from "./Run";
+import { Run } from "./Run.js";
 /**
  * Returns the run stored in an AsyncLocalStorage if running in Node.js. It can be set with `withRun()`.
  */

package/core/getRun.js

@@ -1,13 +1,7 @@
+import { detectRuntime } from "../util/detectRuntime.js";
 let runStorage;
 async function ensureLoaded() {
-    // Note: using process[versions] instead of process.versions to avoid Next.js edge runtime warnings.
-    const versions = "versions";
-    const isNode = typeof process !== "undefined" &&
-        process[versions] != null &&
-        process[versions].node != null;
-    if (!isNode)
-        return Promise.resolve();
-    if (!runStorage) {
+    if (detectRuntime() === "node" && !runStorage) {
         // Note: using "async_hooks" instead of "node:async_hooks" to avoid webpack fallback problems.
         const { AsyncLocalStorage } = await import("async_hooks");
         runStorage = new AsyncLocalStorage();

package/core/schema/ZodSchema.d.ts

@@ -1,7 +1,7 @@
+import { PartialDeep } from "type-fest";
 import { z } from "zod";
 import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
-import { PartialDeep } from "type-fest";
 export declare function zodSchema<OBJECT>(zodSchema: z.Schema<OBJECT>): ZodSchema<OBJECT>;
 export declare class ZodSchema<OBJECT> implements Schema<OBJECT>, JsonSchemaProducer {
     readonly zodSchema: z.Schema<OBJECT>;

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

@@ -2,6 +2,14 @@
 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), {
@@ -12,6 +20,12 @@ class ObjectStreamResponse extends Response {
     }
 }
 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();

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

@@ -7,9 +7,23 @@ export type ObjectStream<OBJECT> = AsyncIterable<{
     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;

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

@@ -1,4 +1,12 @@
 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), {
@@ -8,6 +16,12 @@ export class ObjectStreamResponse extends Response {
         });
     }
 }
+/**
+ * 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();

package/model-provider/openai/OpenAIChatModel.cjs

@@ -33,11 +33,21 @@ exports.OPENAI_CHAT_MODELS = {
         fineTunedPromptTokenCostInMillicents: null,
         fineTunedCompletionTokenCostInMillicents: null,
     },
+    "gpt-4-turbo-preview": {
+        contextWindowSize: 128000,
+        promptTokenCostInMillicents: 1,
+        completionTokenCostInMillicents: 3,
+    },
     "gpt-4-1106-preview": {
         contextWindowSize: 128000,
         promptTokenCostInMillicents: 1,
         completionTokenCostInMillicents: 3,
     },
+    "gpt-4-0125-preview": {
+        contextWindowSize: 128000,
+        promptTokenCostInMillicents: 1,
+        completionTokenCostInMillicents: 3,
+    },
     "gpt-4-vision-preview": {
         contextWindowSize: 128000,
         promptTokenCostInMillicents: 1,
@@ -65,6 +75,11 @@ exports.OPENAI_CHAT_MODELS = {
         fineTunedPromptTokenCostInMillicents: 0.3,
         fineTunedCompletionTokenCostInMillicents: 0.6,
     },
+    "gpt-3.5-turbo-0125": {
+        contextWindowSize: 16385,
+        promptTokenCostInMillicents: 0.05,
+        completionTokenCostInMillicents: 0.15,
+    },
     "gpt-3.5-turbo-1106": {
         contextWindowSize: 16385,
         promptTokenCostInMillicents: 0.1,

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

@@ -26,11 +26,21 @@ export declare const OPENAI_CHAT_MODELS: {
         fineTunedPromptTokenCostInMillicents: null;
         fineTunedCompletionTokenCostInMillicents: null;
     };
+    "gpt-4-turbo-preview": {
+        contextWindowSize: number;
+        promptTokenCostInMillicents: number;
+        completionTokenCostInMillicents: number;
+    };
     "gpt-4-1106-preview": {
         contextWindowSize: number;
         promptTokenCostInMillicents: number;
         completionTokenCostInMillicents: number;
     };
+    "gpt-4-0125-preview": {
+        contextWindowSize: number;
+        promptTokenCostInMillicents: number;
+        completionTokenCostInMillicents: number;
+    };
     "gpt-4-vision-preview": {
         contextWindowSize: number;
         promptTokenCostInMillicents: number;
@@ -58,6 +68,11 @@ export declare const OPENAI_CHAT_MODELS: {
         fineTunedPromptTokenCostInMillicents: number;
         fineTunedCompletionTokenCostInMillicents: number;
     };
+    "gpt-3.5-turbo-0125": {
+        contextWindowSize: number;
+        promptTokenCostInMillicents: number;
+        completionTokenCostInMillicents: number;
+    };
     "gpt-3.5-turbo-1106": {
         contextWindowSize: number;
         promptTokenCostInMillicents: number;

package/model-provider/openai/OpenAIChatModel.js

@@ -30,11 +30,21 @@ export const OPENAI_CHAT_MODELS = {
         fineTunedPromptTokenCostInMillicents: null,
         fineTunedCompletionTokenCostInMillicents: null,
     },
+    "gpt-4-turbo-preview": {
+        contextWindowSize: 128000,
+        promptTokenCostInMillicents: 1,
+        completionTokenCostInMillicents: 3,
+    },
     "gpt-4-1106-preview": {
         contextWindowSize: 128000,
         promptTokenCostInMillicents: 1,
         completionTokenCostInMillicents: 3,
     },
+    "gpt-4-0125-preview": {
+        contextWindowSize: 128000,
+        promptTokenCostInMillicents: 1,
+        completionTokenCostInMillicents: 3,
+    },
     "gpt-4-vision-preview": {
         contextWindowSize: 128000,
         promptTokenCostInMillicents: 1,
@@ -62,6 +72,11 @@ export const OPENAI_CHAT_MODELS = {
         fineTunedPromptTokenCostInMillicents: 0.3,
         fineTunedCompletionTokenCostInMillicents: 0.6,
     },
+    "gpt-3.5-turbo-0125": {
+        contextWindowSize: 16385,
+        promptTokenCostInMillicents: 0.05,
+        completionTokenCostInMillicents: 0.15,
+    },
     "gpt-3.5-turbo-1106": {
         contextWindowSize: 16385,
         promptTokenCostInMillicents: 0.1,

package/model-provider/openai/OpenAITextEmbeddingModel.cjs

@@ -5,6 +5,16 @@ const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens
 const AbstractOpenAITextEmbeddingModel_js_1 = require("./AbstractOpenAITextEmbeddingModel.cjs");
 const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
 exports.OPENAI_TEXT_EMBEDDING_MODELS = {
+    "text-embedding-3-small": {
+        contextWindowSize: 8192,
+        embeddingDimensions: 1536,
+        tokenCostInMillicents: 0.002,
+    },
+    "text-embedding-3-large": {
+        contextWindowSize: 8192,
+        embeddingDimensions: 3072,
+        tokenCostInMillicents: 0.013,
+    },
     "text-embedding-ada-002": {
         contextWindowSize: 8192,
         embeddingDimensions: 1536,

package/model-provider/openai/OpenAITextEmbeddingModel.d.ts

@@ -2,6 +2,16 @@ import { EmbeddingModel } from "../../model-function/embed/EmbeddingModel.js";
 import { AbstractOpenAITextEmbeddingModel, AbstractOpenAITextEmbeddingModelSettings, OpenAITextEmbeddingResponse } from "./AbstractOpenAITextEmbeddingModel.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 export declare const OPENAI_TEXT_EMBEDDING_MODELS: {
+    "text-embedding-3-small": {
+        contextWindowSize: number;
+        embeddingDimensions: number;
+        tokenCostInMillicents: number;
+    };
+    "text-embedding-3-large": {
+        contextWindowSize: number;
+        embeddingDimensions: number;
+        tokenCostInMillicents: number;
+    };
     "text-embedding-ada-002": {
         contextWindowSize: number;
         embeddingDimensions: number;
@@ -9,7 +19,7 @@ export declare const OPENAI_TEXT_EMBEDDING_MODELS: {
     };
 };
 export type OpenAITextEmbeddingModelType = keyof typeof OPENAI_TEXT_EMBEDDING_MODELS;
-export declare const isOpenAIEmbeddingModel: (model: string) => model is "text-embedding-ada-002";
+export declare const isOpenAIEmbeddingModel: (model: string) => model is "text-embedding-3-small" | "text-embedding-3-large" | "text-embedding-ada-002";
 export declare const calculateOpenAIEmbeddingCostInMillicents: ({ model, responses, }: {
     model: OpenAITextEmbeddingModelType;
     responses: OpenAITextEmbeddingResponse[];
@@ -34,7 +44,7 @@ export interface OpenAITextEmbeddingModelSettings extends AbstractOpenAITextEmbe
 export declare class OpenAITextEmbeddingModel extends AbstractOpenAITextEmbeddingModel<OpenAITextEmbeddingModelSettings> implements EmbeddingModel<string, OpenAITextEmbeddingModelSettings> {
     constructor(settings: OpenAITextEmbeddingModelSettings);
     readonly provider: "openai";
-    get modelName(): "text-embedding-ada-002";
+    get modelName(): "text-embedding-3-small" | "text-embedding-3-large" | "text-embedding-ada-002";
     readonly embeddingDimensions: number;
     readonly tokenizer: TikTokenTokenizer;
     readonly contextWindowSize: number;

package/model-provider/openai/OpenAITextEmbeddingModel.js

@@ -2,6 +2,16 @@ import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { AbstractOpenAITextEmbeddingModel, } from "./AbstractOpenAITextEmbeddingModel.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 export const OPENAI_TEXT_EMBEDDING_MODELS = {
+    "text-embedding-3-small": {
+        contextWindowSize: 8192,
+        embeddingDimensions: 1536,
+        tokenCostInMillicents: 0.002,
+    },
+    "text-embedding-3-large": {
+        contextWindowSize: 8192,
+        embeddingDimensions: 3072,
+        tokenCostInMillicents: 0.013,
+    },
     "text-embedding-ada-002": {
         contextWindowSize: 8192,
         embeddingDimensions: 1536,

package/model-provider/openai/TikTokenTokenizer.cjs

@@ -58,17 +58,22 @@ function getTiktokenBPE(model) {
         case "gpt-3.5-turbo-0301":
         case "gpt-3.5-turbo-0613":
         case "gpt-3.5-turbo-1106":
+        case "gpt-3.5-turbo-0125":
         case "gpt-3.5-turbo-16k":
         case "gpt-3.5-turbo-16k-0613":
         case "gpt-3.5-turbo-instruct":
         case "gpt-4":
         case "gpt-4-0314":
         case "gpt-4-0613":
+        case "gpt-4-turbo-preview":
         case "gpt-4-1106-preview":
+        case "gpt-4-0125-preview":
         case "gpt-4-vision-preview":
         case "gpt-4-32k":
         case "gpt-4-32k-0314":
         case "gpt-4-32k-0613":
+        case "text-embedding-3-small":
+        case "text-embedding-3-large":
         case "text-embedding-ada-002": {
             return cl100k_base_1.default;
         }

package/model-provider/openai/TikTokenTokenizer.js

@@ -51,17 +51,22 @@ function getTiktokenBPE(model) {
         case "gpt-3.5-turbo-0301":
         case "gpt-3.5-turbo-0613":
         case "gpt-3.5-turbo-1106":
+        case "gpt-3.5-turbo-0125":
         case "gpt-3.5-turbo-16k":
         case "gpt-3.5-turbo-16k-0613":
         case "gpt-3.5-turbo-instruct":
         case "gpt-4":
         case "gpt-4-0314":
         case "gpt-4-0613":
+        case "gpt-4-turbo-preview":
         case "gpt-4-1106-preview":
+        case "gpt-4-0125-preview":
         case "gpt-4-vision-preview":
         case "gpt-4-32k":
         case "gpt-4-32k-0314":
         case "gpt-4-32k-0613":
+        case "text-embedding-3-small":
+        case "text-embedding-3-large":
         case "text-embedding-ada-002": {
             return cl100k_base;
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
   "description": "The TypeScript library for building AI applications.",
-  "version": "0.131.0",
+  "version": "0.132.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [
@@ -67,6 +67,7 @@
     "js-tiktoken": "1.0.7",
     "nanoid": "3.3.6",
     "secure-json-parse": "2.7.0",
+    "type-fest": "4.9.0",
     "ws": "8.14.2",
     "zod": "3.22.4",
     "zod-to-json-schema": "3.22.3"
@@ -80,7 +81,6 @@
     "@vitest/ui": "1.1.0",
     "eslint": "^8.45.0",
     "eslint-config-prettier": "9.1.0",
-    "msw": "2.1.2",
-    "type-fest": "4.9.0"
+    "msw": "2.1.2"
   }
 }