diff --git a/.changeset/beige-coats-enjoy.md b/.changeset/beige-coats-enjoy.md
new file mode 100644
index 0000000000000000000000000000000000000000..ff35c2d28fa182a83e30eebc6b861b0d75fa54de
--- /dev/null
+++ b/.changeset/beige-coats-enjoy.md
@@ -0,0 +1,9 @@
+---
+"@llamaindex/core": patch
+"@llamaindex/env": patch
+"llamaindex": patch
+---
+
+feat: add `load-transformers` event type when loading `@xenova/transformers` module
+
+This would benefit user who want to customize the transformer env.
diff --git a/packages/core/src/global/settings/callback-manager.ts b/packages/core/src/global/settings/callback-manager.ts
index 94bd303ae83fe5ef7a3db831e1f1153a85fac2de..52ceba77212e18cfde738b9b504669ed2e1944e9 100644
--- a/packages/core/src/global/settings/callback-manager.ts
+++ b/packages/core/src/global/settings/callback-manager.ts
@@ -128,16 +128,29 @@ export class CallbackManager {
dispatchEvent<K extends keyof LlamaIndexEventMaps>(
event: K,
detail: LlamaIndexEventMaps[K],
+ sync = false,
) {
const cbs = this.#handlers.get(event);
if (!cbs) {
return;
}
- queueMicrotask(() => {
+ if (typeof queueMicrotask === "undefined") {
+ console.warn(
+ "queueMicrotask is not available, dispatching synchronously",
+ );
+ sync = true;
+ }
+ if (sync) {
cbs.forEach((handler) =>
handler(LlamaIndexCustomEvent.fromEvent(event, { ...detail })),
);
- });
+ } else {
+ queueMicrotask(() => {
+ cbs.forEach((handler) =>
+ handler(LlamaIndexCustomEvent.fromEvent(event, { ...detail })),
+ );
+ });
+ }
}
}
diff --git a/packages/env/package.json b/packages/env/package.json
index 95825243db6d697ad6bc970f401021e29d14b4b7..3f551b8eb693a90e6f3156ff0b9fa32978ccba47 100644
--- a/packages/env/package.json
+++ b/packages/env/package.json
@@ -74,16 +74,18 @@
"@aws-crypto/sha256-js": "^5.2.0",
"@swc/cli": "^0.4.0",
"@swc/core": "^1.7.22",
+ "@xenova/transformers": "^2.17.2",
"concurrently": "^8.2.2",
"pathe": "^1.1.2",
+ "tiktoken": "^1.0.16",
"vitest": "^2.0.5"
},
"dependencies": {
- "@types/lodash": "^4.17.7",
"@types/node": "^22.5.1"
},
"peerDependencies": {
"@aws-crypto/sha256-js": "^5.2.0",
+ "@xenova/transformers": "^2.17.2",
"js-tiktoken": "^1.0.12",
"pathe": "^1.1.2",
"tiktoken": "^1.0.15"
@@ -92,8 +94,17 @@
"@aws-crypto/sha256-js": {
"optional": true
},
+ "@xenova/transformers": {
+ "optional": true
+ },
"pathe": {
"optional": true
+ },
+ "tiktoken": {
+ "optional": true
+ },
+ "js-tiktoken": {
+ "optional": true
}
}
}
diff --git a/packages/env/src/index.browser.ts b/packages/env/src/index.browser.ts
index 3ab85b4864612137e1dbe786d98985df065dff20..fa0c505ef1b5fbf0d5fda6502ba17ab2743a3b97 100644
--- a/packages/env/src/index.browser.ts
+++ b/packages/env/src/index.browser.ts
@@ -6,6 +6,12 @@
import "./global-check.js";
export * from "./web-polyfill.js";
+export {
+ loadTransformers,
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./multi-model/index.browser.js";
export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/js.js";
// @ts-expect-error
diff --git a/packages/env/src/index.edge-light.ts b/packages/env/src/index.edge-light.ts
index 08d2a53d84c39353f49f2b732f2cd70ba281a173..fb6b70c00477f993b1c69cd94b78c854c963cce3 100644
--- a/packages/env/src/index.edge-light.ts
+++ b/packages/env/src/index.edge-light.ts
@@ -6,4 +6,10 @@
import "./global-check.js";
export * from "./node-polyfill.js";
+export {
+ loadTransformers,
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./multi-model/index.non-nodejs.js";
export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/js.js";
diff --git a/packages/env/src/index.ts b/packages/env/src/index.ts
index 32d4700800a19e0538f18fd88fef504974c24c4a..3f784c42b8b4b7a746a589ce99361b52528fb123 100644
--- a/packages/env/src/index.ts
+++ b/packages/env/src/index.ts
@@ -33,6 +33,12 @@ export function createSHA256(): SHA256 {
};
}
+export {
+ loadTransformers,
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./multi-model/index.js";
export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/node.js";
export {
AsyncLocalStorage,
diff --git a/packages/env/src/index.workerd.ts b/packages/env/src/index.workerd.ts
index 391af61218d46489aa7ce35bdc2b37957ceb8f63..e688fe1dea88403fe17d303b0d8b4f2403087d44 100644
--- a/packages/env/src/index.workerd.ts
+++ b/packages/env/src/index.workerd.ts
@@ -13,4 +13,10 @@ export function getEnv(name: string): string | undefined {
return INTERNAL_ENV[name];
}
+export {
+ loadTransformers,
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./multi-model/index.non-nodejs.js";
export { Tokenizers, tokenizers, type Tokenizer } from "./tokenizers/js.js";
diff --git a/packages/env/src/multi-model/index.browser.ts b/packages/env/src/multi-model/index.browser.ts
new file mode 100644
index 0000000000000000000000000000000000000000..0875f923e4245a056aae13ae03421aece5e5a498
--- /dev/null
+++ b/packages/env/src/multi-model/index.browser.ts
@@ -0,0 +1,20 @@
+import { getTransformers, setTransformers, type OnLoad } from "./shared.js";
+
+export {
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./shared.js";
+export async function loadTransformers(onLoad: OnLoad) {
+ if (getTransformers() === null) {
+ setTransformers(
+ // @ts-expect-error
+ await import("https://cdn.jsdelivr.net/npm/@xenova/transformers@2.17.2"),
+ );
+ } else {
+ return getTransformers()!;
+ }
+ const transformer = getTransformers()!;
+ onLoad(transformer);
+ return transformer;
+}
diff --git a/packages/env/src/multi-model/index.non-nodejs.ts b/packages/env/src/multi-model/index.non-nodejs.ts
new file mode 100644
index 0000000000000000000000000000000000000000..817166e6118e627f34d61e2c9736259bd9b0c2ef
--- /dev/null
+++ b/packages/env/src/multi-model/index.non-nodejs.ts
@@ -0,0 +1,35 @@
+import { getTransformers, setTransformers, type OnLoad } from "./shared.js";
+export {
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./shared.js";
+
+export async function loadTransformers(onLoad: OnLoad) {
+ if (getTransformers() === null) {
+ /**
+ * If you see this warning, it means that the current environment does not support the transformer.
+ * because "@xeonva/transformers" highly depends on Node.js APIs.
+ *
+ * One possible solution is to fix their implementation to make it work in the non-Node.js environment,
+ * but it's not worth the effort because Edge Runtime and Cloudflare Workers are not the for heavy Machine Learning task.
+ *
+ * Or you can provide an RPC server that runs the transformer in a Node.js environment.
+ * Or you just run the code in a Node.js environment.
+ *
+ * Refs: https://github.com/xenova/transformers.js/issues/309
+ */
+ console.warn(
+ '"@xenova/transformers" is not officially supported in this environment, some features may not work as expected.',
+ );
+ setTransformers(
+ // @ts-expect-error
+ await import("@xenova/transformers/dist/transformers"),
+ );
+ } else {
+ return getTransformers()!;
+ }
+ const transformer = getTransformers()!;
+ onLoad(transformer);
+ return transformer;
+}
diff --git a/packages/env/src/multi-model/index.ts b/packages/env/src/multi-model/index.ts
new file mode 100644
index 0000000000000000000000000000000000000000..2b34300600df6940ccbadd512deb28ab5350fd6e
--- /dev/null
+++ b/packages/env/src/multi-model/index.ts
@@ -0,0 +1,20 @@
+import { getTransformers, setTransformers, type OnLoad } from "./shared.js";
+
+export {
+ setTransformers,
+ type LoadTransformerEvent,
+ type OnLoad,
+} from "./shared.js";
+
+export async function loadTransformers(onLoad: OnLoad) {
+ if (getTransformers() === null) {
+ setTransformers(await import("@xenova/transformers"));
+ } else {
+ return getTransformers()!;
+ }
+ const transformer = getTransformers()!;
+
+ onLoad(transformer);
+
+ return transformer;
+}
diff --git a/packages/env/src/multi-model/shared.ts b/packages/env/src/multi-model/shared.ts
new file mode 100644
index 0000000000000000000000000000000000000000..7247a1a8c539c5d9a7c83158ad38c324508d928a
--- /dev/null
+++ b/packages/env/src/multi-model/shared.ts
@@ -0,0 +1,17 @@
+let transformer: typeof import("@xenova/transformers") | null = null;
+
+export function getTransformers() {
+ return transformer;
+}
+
+export function setTransformers(t: typeof import("@xenova/transformers")) {
+ transformer = t;
+}
+
+export type OnLoad = (
+ transformer: typeof import("@xenova/transformers"),
+) => void;
+
+export type LoadTransformerEvent = {
+ transformer: typeof import("@xenova/transformers");
+};
diff --git a/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/app/globals.css b/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/app/globals.css
index f4bd77c0ccacd185f097e1fe5a2975992fb989a1..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 100644
--- a/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/app/globals.css
+++ b/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/app/globals.css
@@ -1,107 +0,0 @@
-:root {
- --max-width: 1100px;
- --border-radius: 12px;
- --font-mono: ui-monospace, Menlo, Monaco, "Cascadia Mono", "Segoe UI Mono",
- "Roboto Mono", "Oxygen Mono", "Ubuntu Monospace", "Source Code Pro",
- "Fira Mono", "Droid Sans Mono", "Courier New", monospace;
-
- --foreground-rgb: 0, 0, 0;
- --background-start-rgb: 214, 219, 220;
- --background-end-rgb: 255, 255, 255;
-
- --primary-glow: conic-gradient(
- from 180deg at 50% 50%,
- #16abff33 0deg,
- #0885ff33 55deg,
- #54d6ff33 120deg,
- #0071ff33 160deg,
- transparent 360deg
- );
- --secondary-glow: radial-gradient(
- rgba(255, 255, 255, 1),
- rgba(255, 255, 255, 0)
- );
-
- --tile-start-rgb: 239, 245, 249;
- --tile-end-rgb: 228, 232, 233;
- --tile-border: conic-gradient(
- #00000080,
- #00000040,
- #00000030,
- #00000020,
- #00000010,
- #00000010,
- #00000080
- );
-
- --callout-rgb: 238, 240, 241;
- --callout-border-rgb: 172, 175, 176;
- --card-rgb: 180, 185, 188;
- --card-border-rgb: 131, 134, 135;
-}
-
-@media (prefers-color-scheme: dark) {
- :root {
- --foreground-rgb: 255, 255, 255;
- --background-start-rgb: 0, 0, 0;
- --background-end-rgb: 0, 0, 0;
-
- --primary-glow: radial-gradient(rgba(1, 65, 255, 0.4), rgba(1, 65, 255, 0));
- --secondary-glow: linear-gradient(
- to bottom right,
- rgba(1, 65, 255, 0),
- rgba(1, 65, 255, 0),
- rgba(1, 65, 255, 0.3)
- );
-
- --tile-start-rgb: 2, 13, 46;
- --tile-end-rgb: 2, 5, 19;
- --tile-border: conic-gradient(
- #ffffff80,
- #ffffff40,
- #ffffff30,
- #ffffff20,
- #ffffff10,
- #ffffff10,
- #ffffff80
- );
-
- --callout-rgb: 20, 20, 20;
- --callout-border-rgb: 108, 108, 108;
- --card-rgb: 100, 100, 100;
- --card-border-rgb: 200, 200, 200;
- }
-}
-
-* {
- box-sizing: border-box;
- padding: 0;
- margin: 0;
-}
-
-html,
-body {
- max-width: 100vw;
- overflow-x: hidden;
-}
-
-body {
- color: rgb(var(--foreground-rgb));
- background: linear-gradient(
- to bottom,
- transparent,
- rgb(var(--background-end-rgb))
- )
- rgb(var(--background-start-rgb));
-}
-
-a {
- color: inherit;
- text-decoration: none;
-}
-
-@media (prefers-color-scheme: dark) {
- html {
- color-scheme: dark;
- }
-}
diff --git a/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/utils/llm.ts b/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/utils/llm.ts
index 0396636617b20cb64a6e360c4da748d76599733b..30936ae0a64c87efe02b72612b29f3e8b93eb1d0 100644
--- a/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/utils/llm.ts
+++ b/packages/llamaindex/e2e/examples/nextjs-edge-runtime/src/utils/llm.ts
@@ -1,6 +1,6 @@
// test runtime
import "llamaindex";
-import { ClipEmbedding } from "llamaindex/embeddings/ClipEmbedding";
+import { ClipEmbedding } from "llamaindex";
import "llamaindex/readers/SimpleDirectoryReader";
// @ts-expect-error
diff --git a/packages/llamaindex/e2e/node/embedding/clip.e2e.ts b/packages/llamaindex/e2e/node/embedding/clip.e2e.ts
index 110afe5f7fb2bbddb4e51b5fbcd3ae6ff7e03006..975793fc561a9d1512c7355c3598ef2a00a06dda 100644
--- a/packages/llamaindex/e2e/node/embedding/clip.e2e.ts
+++ b/packages/llamaindex/e2e/node/embedding/clip.e2e.ts
@@ -1,8 +1,41 @@
-import { ClipEmbedding, ImageNode } from "llamaindex";
+import type { LoadTransformerEvent } from "@llamaindex/env";
+import { setTransformers } from "@llamaindex/env";
+import { ClipEmbedding, ImageNode, Settings } from "llamaindex";
import assert from "node:assert";
-import { test } from "node:test";
+import { type Mock, test } from "node:test";
+
+let callback: Mock<(event: any) => void>;
+test.before(() => {
+ callback = test.mock.fn((event: any) => {
+ const { transformer } = event.detail as LoadTransformerEvent;
+ assert.ok(transformer);
+ assert.ok(transformer.env);
+ });
+ Settings.callbackManager.on("load-transformers", callback);
+});
+
+test.beforeEach(() => {
+ callback.mock.resetCalls();
+});
await test("clip embedding", async (t) => {
+ await t.test("should trigger load transformer event", async () => {
+ const nodes = [
+ new ImageNode({
+ image: new URL(
+ "../../fixtures/img/llamaindex-white.png",
+ import.meta.url,
+ ),
+ }),
+ ];
+ assert.equal(callback.mock.callCount(), 0);
+ const clipEmbedding = new ClipEmbedding();
+ assert.equal(callback.mock.callCount(), 0);
+ const result = await clipEmbedding(nodes);
+ assert.strictEqual(result.length, 1);
+ assert.equal(callback.mock.callCount(), 1);
+ });
+
await t.test("init & get image embedding", async () => {
const clipEmbedding = new ClipEmbedding();
const imgUrl = new URL(
@@ -27,4 +60,25 @@ await test("clip embedding", async (t) => {
assert.strictEqual(result.length, 1);
assert.ok(result[0]!.embedding);
});
+
+ await t.test("custom transformer", async () => {
+ const transformers = await import("@xenova/transformers");
+ const getter = test.mock.fn((t, k, r) => {
+ return Reflect.get(t, k, r);
+ });
+ setTransformers(
+ new Proxy(transformers, {
+ get: getter,
+ }),
+ );
+ const clipEmbedding = new ClipEmbedding();
+ const imgUrl = new URL(
+ "../../fixtures/img/llamaindex-white.png",
+ import.meta.url,
+ );
+ assert.equal(getter.mock.callCount(), 0);
+ const vec = await clipEmbedding.getImageEmbedding(imgUrl);
+ assert.ok(vec);
+ assert.ok(getter.mock.callCount() > 0);
+ });
});
diff --git a/packages/llamaindex/package.json b/packages/llamaindex/package.json
index 9a8fef8d3b16109bbe045657d8c1508c1ba20c2f..48c833e60054eef6c555d56b948cc4d52b1f39fd 100644
--- a/packages/llamaindex/package.json
+++ b/packages/llamaindex/package.json
@@ -33,8 +33,8 @@
"@llamaindex/cloud": "workspace:*",
"@llamaindex/core": "workspace:*",
"@llamaindex/env": "workspace:*",
- "@llamaindex/openai": "workspace:*",
"@llamaindex/groq": "workspace:*",
+ "@llamaindex/openai": "workspace:*",
"@mistralai/mistralai": "^1.0.4",
"@mixedbread-ai/sdk": "^2.2.11",
"@pinecone-database/pinecone": "^3.0.2",
@@ -43,7 +43,6 @@
"@types/node": "^22.5.1",
"@types/papaparse": "^5.3.14",
"@types/pg": "^8.11.8",
- "@xenova/transformers": "^2.17.2",
"@zilliz/milvus2-sdk-node": "^2.4.6",
"ajv": "^8.17.1",
"assemblyai": "^4.7.0",
@@ -91,6 +90,7 @@
"@notionhq/client": "^2.2.15",
"@swc/cli": "^0.4.0",
"@swc/core": "^1.7.22",
+ "@xenova/transformers": "^2.17.2",
"concurrently": "^8.2.2",
"glob": "^11.0.0",
"pg": "^8.12.0",
diff --git a/packages/llamaindex/src/Settings.ts b/packages/llamaindex/src/Settings.ts
index a39fc3b1ab05c427b6e264df68b793556eef8e1d..4eae4745cc81d11b8706fbce5cfe0b9d89734e61 100644
--- a/packages/llamaindex/src/Settings.ts
+++ b/packages/llamaindex/src/Settings.ts
@@ -12,6 +12,7 @@ import {
type NodeParser,
SentenceSplitter,
} from "@llamaindex/core/node-parser";
+import type { LoadTransformerEvent } from "@llamaindex/env";
import { AsyncLocalStorage, getEnv } from "@llamaindex/env";
import type { ServiceContext } from "./ServiceContext.js";
import {
@@ -20,6 +21,12 @@ import {
withEmbeddedModel,
} from "./internal/settings/EmbedModel.js";
+declare module "@llamaindex/core/global" {
+ interface LlamaIndexEventMaps {
+ "load-transformers": LoadTransformerEvent;
+ }
+}
+
export type PromptConfig = {
llm?: string;
lang?: string;
diff --git a/packages/llamaindex/src/embeddings/ClipEmbedding.ts b/packages/llamaindex/src/embeddings/ClipEmbedding.ts
index d52d47cd908f3f8870342bbd56d49b589598265e..484729d8fbe4ce4b23f20f22a023986d99b930f6 100644
--- a/packages/llamaindex/src/embeddings/ClipEmbedding.ts
+++ b/packages/llamaindex/src/embeddings/ClipEmbedding.ts
@@ -1,17 +1,26 @@
import { MultiModalEmbedding } from "@llamaindex/core/embeddings";
import type { ImageType } from "@llamaindex/core/schema";
import _ from "lodash";
-import { lazyLoadTransformers } from "../internal/deps/transformers.js";
// only import type, to avoid bundling error
+import { loadTransformers } from "@llamaindex/env";
import type {
CLIPTextModelWithProjection,
CLIPVisionModelWithProjection,
PreTrainedTokenizer,
Processor,
} from "@xenova/transformers";
+import { Settings } from "../Settings.js";
async function readImage(input: ImageType) {
- const { RawImage } = await lazyLoadTransformers();
+ const { RawImage } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
if (input instanceof Blob) {
return await RawImage.fromBlob(input);
} else if (_.isString(input) || input instanceof URL) {
@@ -40,7 +49,15 @@ export class ClipEmbedding extends MultiModalEmbedding {
}
async getTokenizer() {
- const { AutoTokenizer } = await lazyLoadTransformers();
+ const { AutoTokenizer } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
if (!this.tokenizer) {
this.tokenizer = await AutoTokenizer.from_pretrained(this.modelType);
}
@@ -48,7 +65,15 @@ export class ClipEmbedding extends MultiModalEmbedding {
}
async getProcessor() {
- const { AutoProcessor } = await lazyLoadTransformers();
+ const { AutoProcessor } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
if (!this.processor) {
this.processor = await AutoProcessor.from_pretrained(this.modelType);
}
@@ -56,7 +81,17 @@ export class ClipEmbedding extends MultiModalEmbedding {
}
async getVisionModel() {
- const { CLIPVisionModelWithProjection } = await lazyLoadTransformers();
+ const { CLIPVisionModelWithProjection } = await loadTransformers(
+ (transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ },
+ );
if (!this.visionModel) {
this.visionModel = await CLIPVisionModelWithProjection.from_pretrained(
this.modelType,
@@ -67,7 +102,17 @@ export class ClipEmbedding extends MultiModalEmbedding {
}
async getTextModel() {
- const { CLIPTextModelWithProjection } = await lazyLoadTransformers();
+ const { CLIPTextModelWithProjection } = await loadTransformers(
+ (transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ },
+ );
if (!this.textModel) {
this.textModel = await CLIPTextModelWithProjection.from_pretrained(
this.modelType,
diff --git a/packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts b/packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts
index 4139dba14f86bad5be76ed09726ebbd86a96cae3..e15c90ab9774a579440c188caeae2430705310ba 100644
--- a/packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts
+++ b/packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts
@@ -1,6 +1,7 @@
import { HfInference } from "@huggingface/inference";
import { BaseEmbedding } from "@llamaindex/core/embeddings";
-import { lazyLoadTransformers } from "../internal/deps/transformers.js";
+import { loadTransformers } from "@llamaindex/env";
+import { Settings } from "../Settings.js";
export enum HuggingFaceEmbeddingModelType {
XENOVA_ALL_MINILM_L6_V2 = "Xenova/all-MiniLM-L6-v2",
@@ -33,7 +34,15 @@ export class HuggingFaceEmbedding extends BaseEmbedding {
async getExtractor() {
if (!this.extractor) {
- const { pipeline } = await lazyLoadTransformers();
+ const { pipeline } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
this.extractor = await pipeline("feature-extraction", this.modelType, {
quantized: this.quantized,
});
diff --git a/packages/llamaindex/src/embeddings/index.ts b/packages/llamaindex/src/embeddings/index.ts
index a93a1d378a44dd06d7bbf06123bd3c6c605bef63..0e462299b8ebf726081846fb45d0bcb3fc71d2ad 100644
--- a/packages/llamaindex/src/embeddings/index.ts
+++ b/packages/llamaindex/src/embeddings/index.ts
@@ -9,3 +9,5 @@ export * from "./MixedbreadAIEmbeddings.js";
export { OllamaEmbedding } from "./OllamaEmbedding.js";
export * from "./OpenAIEmbedding.js";
export { TogetherEmbedding } from "./together.js";
+// ClipEmbedding might not work in non-node.js runtime, but it doesn't have side effects
+export { ClipEmbedding, ClipEmbeddingModelType } from "./ClipEmbedding.js";
diff --git a/packages/llamaindex/src/index.ts b/packages/llamaindex/src/index.ts
index 0dbfe741112aab117e756e3969d4192745e32d70..25231f37617b4f979d819a48515dd46b63e063e9 100644
--- a/packages/llamaindex/src/index.ts
+++ b/packages/llamaindex/src/index.ts
@@ -2,10 +2,6 @@ export * from "./index.edge.js";
export * from "./readers/index.js";
export * from "./storage/index.js";
// Exports modules that doesn't support non-node.js runtime
-export {
- ClipEmbedding,
- ClipEmbeddingModelType,
-} from "./embeddings/ClipEmbedding.js";
export {
HuggingFaceEmbedding,
HuggingFaceEmbeddingModelType,
diff --git a/packages/llamaindex/src/internal/deps/transformers.ts b/packages/llamaindex/src/internal/deps/transformers.ts
deleted file mode 100644
index 96ebceaa47322e79de22fc4f8e6ccac7fa9c448e..0000000000000000000000000000000000000000
--- a/packages/llamaindex/src/internal/deps/transformers.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-let transformer: typeof import("@xenova/transformers") | null = null;
-
-export async function lazyLoadTransformers() {
- if (!transformer) {
- transformer = await import("@xenova/transformers");
- }
-
- // @ts-expect-error
- if (typeof EdgeRuntime === "string") {
- // there is no local file system in the edge runtime
- transformer.env.allowLocalModels = false;
- }
- // fixme: handle cloudflare workers case here?
- return transformer;
-}
diff --git a/packages/llamaindex/src/llm/huggingface.ts b/packages/llamaindex/src/llm/huggingface.ts
index 86fb40529d328daa0a2854e632090fb5bec7c6c7..162edd27ec07329cd366ab2fe29c800acd13631d 100644
--- a/packages/llamaindex/src/llm/huggingface.ts
+++ b/packages/llamaindex/src/llm/huggingface.ts
@@ -11,12 +11,13 @@ import {
type ToolCallLLMMessageOptions,
} from "@llamaindex/core/llms";
import { streamConverter, wrapLLMEvent } from "@llamaindex/core/utils";
+import { loadTransformers } from "@llamaindex/env";
import type {
PreTrainedModel,
PreTrainedTokenizer,
Tensor,
} from "@xenova/transformers";
-import { lazyLoadTransformers } from "../internal/deps/transformers.js";
+import { Settings } from "../Settings.js";
// TODO workaround issue with @huggingface/inference@2.7.0
interface HfInferenceOptions {
@@ -225,7 +226,15 @@ export class HuggingFaceLLM extends BaseLLM {
}
async getTokenizer() {
- const { AutoTokenizer } = await lazyLoadTransformers();
+ const { AutoTokenizer } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
if (!this.tokenizer) {
this.tokenizer = await AutoTokenizer.from_pretrained(this.tokenizerName);
}
@@ -233,7 +242,15 @@ export class HuggingFaceLLM extends BaseLLM {
}
async getModel() {
- const { AutoModelForCausalLM } = await lazyLoadTransformers();
+ const { AutoModelForCausalLM } = await loadTransformers((transformer) => {
+ Settings.callbackManager.dispatchEvent(
+ "load-transformers",
+ {
+ transformer,
+ },
+ true,
+ );
+ });
if (!this.model) {
this.model = await AutoModelForCausalLM.from_pretrained(this.modelName);
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 998bd6ae6201fd2fcda76181d7eb247c691c5acb..4497b5a566cf15dc95d6ebb6ac5b5ab4ee3f826f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -167,7 +167,7 @@ importers:
version: link:../packages/llamaindex
mongodb:
specifier: ^6.7.0
- version: 6.8.0(@aws-sdk/credential-providers@3.650.0(@aws-sdk/client-sso-oidc@3.650.0(@aws-sdk/client-sts@3.650.0)))
+ version: 6.8.0(@aws-sdk/credential-providers@3.650.0)
pathe:
specifier: ^1.1.2
version: 1.1.2
@@ -425,18 +425,12 @@ importers:
packages/env:
dependencies:
- '@types/lodash':
- specifier: ^4.17.7
- version: 4.17.7
'@types/node':
specifier: ^22.5.1
version: 22.5.4
js-tiktoken:
specifier: ^1.0.12
version: 1.0.14
- tiktoken:
- specifier: ^1.0.15
- version: 1.0.16
devDependencies:
'@aws-crypto/sha256-js':
specifier: ^5.2.0
@@ -447,12 +441,18 @@ importers:
'@swc/core':
specifier: ^1.7.22
version: 1.7.22(@swc/helpers@0.5.13)
+ '@xenova/transformers':
+ specifier: ^2.17.2
+ version: 2.17.2
concurrently:
specifier: ^8.2.2
version: 8.2.2
pathe:
specifier: ^1.1.2
version: 1.1.2
+ tiktoken:
+ specifier: ^1.0.16
+ version: 1.0.16
vitest:
specifier: ^2.0.5
version: 2.1.1(@edge-runtime/vm@4.0.3)(@types/node@22.5.4)(happy-dom@15.7.4)(msw@2.4.8(typescript@5.6.2))(terser@5.32.0)
@@ -565,9 +565,6 @@ importers:
'@types/pg':
specifier: ^8.11.8
version: 8.11.8
- '@xenova/transformers':
- specifier: ^2.17.2
- version: 2.17.2
'@zilliz/milvus2-sdk-node':
specifier: ^2.4.6
version: 2.4.6
@@ -606,7 +603,7 @@ importers:
version: 2.0.0
mongodb:
specifier: ^6.7.0
- version: 6.8.0(@aws-sdk/credential-providers@3.650.0(@aws-sdk/client-sso-oidc@3.650.0(@aws-sdk/client-sts@3.650.0)))
+ version: 6.8.0(@aws-sdk/credential-providers@3.650.0)
notion-md-crawler:
specifier: ^1.0.0
version: 1.0.0(encoding@0.1.13)
@@ -656,6 +653,9 @@ importers:
'@swc/core':
specifier: ^1.7.22
version: 1.7.22(@swc/helpers@0.5.13)
+ '@xenova/transformers':
+ specifier: ^2.17.2
+ version: 2.17.2
concurrently:
specifier: ^8.2.2
version: 8.2.2
@@ -18506,7 +18506,7 @@ snapshots:
'@typescript-eslint/parser': 7.2.0(eslint@8.57.0)(typescript@5.6.2)
eslint: 8.57.0
eslint-import-resolver-node: 0.3.9
- eslint-import-resolver-typescript: 3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0)
+ eslint-import-resolver-typescript: 3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1)(eslint@8.57.0)
eslint-plugin-import: 2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.0)
eslint-plugin-jsx-a11y: 6.9.0(eslint@8.57.0)
eslint-plugin-react: 7.35.0(eslint@8.57.0)
@@ -18554,25 +18554,6 @@ snapshots:
transitivePeerDependencies:
- supports-color
- eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0):
- dependencies:
- '@nolyfill/is-core-module': 1.0.39
- debug: 4.3.7
- enhanced-resolve: 5.17.1
- eslint: 8.57.0
- eslint-module-utils: 2.8.2(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0))(eslint@8.57.0)
- fast-glob: 3.3.2
- get-tsconfig: 4.8.0
- is-bun-module: 1.1.0
- is-glob: 4.0.3
- optionalDependencies:
- eslint-plugin-import: 2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.0)
- transitivePeerDependencies:
- - '@typescript-eslint/parser'
- - eslint-import-resolver-node
- - eslint-import-resolver-webpack
- - supports-color
-
eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1)(eslint@8.57.0):
dependencies:
'@nolyfill/is-core-module': 1.0.39
@@ -18585,24 +18566,13 @@ snapshots:
is-bun-module: 1.1.0
is-glob: 4.0.3
optionalDependencies:
- eslint-plugin-import: 2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-typescript@3.6.3)(eslint@8.57.0)
+ eslint-plugin-import: 2.29.1(@typescript-eslint/parser@8.5.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0)
transitivePeerDependencies:
- '@typescript-eslint/parser'
- eslint-import-resolver-node
- eslint-import-resolver-webpack
- supports-color
- eslint-module-utils@2.8.2(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0))(eslint@8.57.0):
- dependencies:
- debug: 3.2.7
- optionalDependencies:
- '@typescript-eslint/parser': 7.2.0(eslint@8.57.0)(typescript@5.6.2)
- eslint: 8.57.0
- eslint-import-resolver-node: 0.3.9
- eslint-import-resolver-typescript: 3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0)
- transitivePeerDependencies:
- - supports-color
-
eslint-module-utils@2.8.2(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1)(eslint@8.57.0))(eslint@8.57.0):
dependencies:
debug: 3.2.7
@@ -18624,7 +18594,7 @@ snapshots:
doctrine: 2.1.0
eslint: 8.57.0
eslint-import-resolver-node: 0.3.9
- eslint-module-utils: 2.8.2(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint@8.57.0))(eslint@8.57.0))(eslint@8.57.0)
+ eslint-module-utils: 2.8.2(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.3(@typescript-eslint/parser@7.2.0(eslint@8.57.0)(typescript@5.6.2))(eslint-import-resolver-node@0.3.9)(eslint-plugin-import@2.29.1)(eslint@8.57.0))(eslint@8.57.0)
hasown: 2.0.2
is-core-module: 2.15.1
is-glob: 4.0.3
@@ -21357,7 +21327,7 @@ snapshots:
optionalDependencies:
'@aws-sdk/credential-providers': 3.650.0(@aws-sdk/client-sso-oidc@3.650.0(@aws-sdk/client-sts@3.650.0))
- mongodb@6.8.0(@aws-sdk/credential-providers@3.650.0(@aws-sdk/client-sso-oidc@3.650.0(@aws-sdk/client-sts@3.650.0))):
+ mongodb@6.8.0(@aws-sdk/credential-providers@3.650.0):
dependencies:
'@mongodb-js/saslprep': 1.1.7
bson: 6.8.0