chromadb 1.7.3-beta1 → 1.7.3-beta2

package/dist/chromadb.d.ts

@@ -1,6 +1,7 @@
 import * as openai from 'openai';
 import * as cohere_ai from 'cohere-ai';
 import * as _xenova_transformers from '@xenova/transformers';
+import * as chromadb_default_embed from 'chromadb-default-embed';
 
 interface IEmbeddingFunction {
     generate(texts: string[]): Promise<number[][]>;
@@ -1006,4 +1007,33 @@ declare class TransformersEmbeddingFunction implements IEmbeddingFunction {
     }>;
 }
 
-export { ChromaClient, CohereEmbeddingFunction, Collection, type IEmbeddingFunction, IncludeEnum, OpenAIEmbeddingFunction, TransformersEmbeddingFunction };
+declare class DefaultEmbeddingFunction implements IEmbeddingFunction {
+    private pipelinePromise?;
+    private transformersApi;
+    private model;
+    private revision;
+    private quantized;
+    private progress_callback;
+    /**
+     * DefaultEmbeddingFunction constructor.
+     * @param options The configuration options.
+     * @param options.model The model to use to calculate embeddings. Defaults to 'Xenova/all-MiniLM-L6-v2', which is an ONNX port of `sentence-transformers/all-MiniLM-L6-v2`.
+     * @param options.revision The specific model version to use (can be a branch, tag name, or commit id). Defaults to 'main'.
+     * @param options.quantized Whether to load the 8-bit quantized version of the model. Defaults to `false`.
+     * @param options.progress_callback If specified, this function will be called during model construction, to provide the user with progress updates.
+     */
+    constructor({ model, revision, quantized, progress_callback, }?: {
+        model?: string;
+        revision?: string;
+        quantized?: boolean;
+        progress_callback?: Function | null;
+    });
+    generate(texts: string[]): Promise<number[][]>;
+    private loadClient;
+    /** @ignore */
+    static import(): Promise<{
+        pipeline: typeof chromadb_default_embed;
+    }>;
+}
+
+export { ChromaClient, CohereEmbeddingFunction, Collection, DefaultEmbeddingFunction, type IEmbeddingFunction, IncludeEnum, OpenAIEmbeddingFunction, TransformersEmbeddingFunction };

package/dist/chromadb.legacy-esm.js

@@ -1869,11 +1869,11 @@ var IsomorphicFetchClientAuthProtocolAdapter = class {
   }
 };
 
-// src/embeddings/TransformersEmbeddingFunction.ts
+// src/embeddings/DefaultEmbeddingFunction.ts
 var TransformersApi;
-var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
+var DefaultEmbeddingFunction = class _DefaultEmbeddingFunction {
   /**
-   * TransformersEmbeddingFunction constructor.
+   * DefaultEmbeddingFunction constructor.
    * @param options The configuration options.
    * @param options.model The model to use to calculate embeddings. Defaults to 'Xenova/all-MiniLM-L6-v2', which is an ONNX port of `sentence-transformers/all-MiniLM-L6-v2`.
    * @param options.revision The specific model version to use (can be a branch, tag name, or commit id). Defaults to 'main'.
@@ -1918,11 +1918,11 @@ var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
     if (this.transformersApi)
       return;
     try {
-      let { pipeline } = await _TransformersEmbeddingFunction.import();
+      let { pipeline } = await _DefaultEmbeddingFunction.import();
       TransformersApi = pipeline;
     } catch (_a) {
       if (_a.code === "MODULE_NOT_FOUND") {
-        throw new Error("Please install the @xenova/transformers package to use the TransformersEmbeddingFunction, `npm install -S @xenova/transformers`");
+        throw new Error("Please install the chromadb-default-embed package to use the DefaultEmbeddingFunction, `npm install -S chromadb-default-embed`");
       }
       throw _a;
     }
@@ -1931,11 +1931,11 @@ var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
   /** @ignore */
   static async import() {
     try {
-      const { pipeline } = await import("@xenova/transformers");
+      const { pipeline } = await import("chromadb-default-embed");
       return { pipeline };
     } catch (e) {
       throw new Error(
-        "Please install @xenova/transformers as a dependency with, e.g. `yarn add @xenova/transformers`"
+        "Please install chromadb-default-embed as a dependency with, e.g. `yarn add chromadb-default-embed`"
       );
     }
   }
@@ -2042,7 +2042,7 @@ var ChromaClient = class {
     embeddingFunction
   }) {
     if (embeddingFunction === void 0) {
-      embeddingFunction = new TransformersEmbeddingFunction();
+      embeddingFunction = new DefaultEmbeddingFunction();
     }
     const newCollection = await this.api.createCollection({
       name,
@@ -2080,7 +2080,7 @@ var ChromaClient = class {
     embeddingFunction
   }) {
     if (embeddingFunction === void 0) {
-      embeddingFunction = new TransformersEmbeddingFunction();
+      embeddingFunction = new DefaultEmbeddingFunction();
     }
     const newCollection = await this.api.createCollection({
       name,
@@ -2305,6 +2305,78 @@ var CohereEmbeddingFunction = class _CohereEmbeddingFunction {
   }
 };
 
+// src/embeddings/TransformersEmbeddingFunction.ts
+var TransformersApi2;
+var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
+  /**
+   * TransformersEmbeddingFunction constructor.
+   * @param options The configuration options.
+   * @param options.model The model to use to calculate embeddings. Defaults to 'Xenova/all-MiniLM-L6-v2', which is an ONNX port of `sentence-transformers/all-MiniLM-L6-v2`.
+   * @param options.revision The specific model version to use (can be a branch, tag name, or commit id). Defaults to 'main'.
+   * @param options.quantized Whether to load the 8-bit quantized version of the model. Defaults to `false`.
+   * @param options.progress_callback If specified, this function will be called during model construction, to provide the user with progress updates.
+   */
+  constructor({
+    model = "Xenova/all-MiniLM-L6-v2",
+    revision = "main",
+    quantized = false,
+    progress_callback = null
+  } = {}) {
+    this.model = model;
+    this.revision = revision;
+    this.quantized = quantized;
+    this.progress_callback = progress_callback;
+  }
+  async generate(texts) {
+    await this.loadClient();
+    this.pipelinePromise = new Promise(async (resolve, reject) => {
+      try {
+        const pipeline = this.transformersApi;
+        const quantized = this.quantized;
+        const revision = this.revision;
+        const progress_callback = this.progress_callback;
+        resolve(
+          await pipeline("feature-extraction", this.model, {
+            quantized,
+            revision,
+            progress_callback
+          })
+        );
+      } catch (e) {
+        reject(e);
+      }
+    });
+    let pipe = await this.pipelinePromise;
+    let output = await pipe(texts, { pooling: "mean", normalize: true });
+    return output.tolist();
+  }
+  async loadClient() {
+    if (this.transformersApi)
+      return;
+    try {
+      let { pipeline } = await _TransformersEmbeddingFunction.import();
+      TransformersApi2 = pipeline;
+    } catch (_a) {
+      if (_a.code === "MODULE_NOT_FOUND") {
+        throw new Error("Please install the @xenova/transformers package to use the TransformersEmbeddingFunction, `npm install -S @xenova/transformers`");
+      }
+      throw _a;
+    }
+    this.transformersApi = TransformersApi2;
+  }
+  /** @ignore */
+  static async import() {
+    try {
+      const { pipeline } = await import("@xenova/transformers");
+      return { pipeline };
+    } catch (e) {
+      throw new Error(
+        "Please install @xenova/transformers as a dependency with, e.g. `yarn add @xenova/transformers`"
+      );
+    }
+  }
+};
+
 // src/types.ts
 var IncludeEnum = /* @__PURE__ */ ((IncludeEnum2) => {
   IncludeEnum2["Documents"] = "documents";
@@ -2317,6 +2389,7 @@ export {
   ChromaClient,
   CohereEmbeddingFunction,
   Collection,
+  DefaultEmbeddingFunction,
   IncludeEnum,
   OpenAIEmbeddingFunction,
   TransformersEmbeddingFunction

package/dist/chromadb.mjs

@@ -1869,11 +1869,11 @@ var IsomorphicFetchClientAuthProtocolAdapter = class {
   }
 };
 
-// src/embeddings/TransformersEmbeddingFunction.ts
+// src/embeddings/DefaultEmbeddingFunction.ts
 var TransformersApi;
-var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
+var DefaultEmbeddingFunction = class _DefaultEmbeddingFunction {
   /**
-   * TransformersEmbeddingFunction constructor.
+   * DefaultEmbeddingFunction constructor.
    * @param options The configuration options.
    * @param options.model The model to use to calculate embeddings. Defaults to 'Xenova/all-MiniLM-L6-v2', which is an ONNX port of `sentence-transformers/all-MiniLM-L6-v2`.
    * @param options.revision The specific model version to use (can be a branch, tag name, or commit id). Defaults to 'main'.
@@ -1918,11 +1918,11 @@ var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
     if (this.transformersApi)
       return;
     try {
-      let { pipeline } = await _TransformersEmbeddingFunction.import();
+      let { pipeline } = await _DefaultEmbeddingFunction.import();
       TransformersApi = pipeline;
     } catch (_a) {
       if (_a.code === "MODULE_NOT_FOUND") {
-        throw new Error("Please install the @xenova/transformers package to use the TransformersEmbeddingFunction, `npm install -S @xenova/transformers`");
+        throw new Error("Please install the chromadb-default-embed package to use the DefaultEmbeddingFunction, `npm install -S chromadb-default-embed`");
       }
       throw _a;
     }
@@ -1931,11 +1931,11 @@ var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
   /** @ignore */
   static async import() {
     try {
-      const { pipeline } = await import("@xenova/transformers");
+      const { pipeline } = await import("chromadb-default-embed");
       return { pipeline };
     } catch (e) {
       throw new Error(
-        "Please install @xenova/transformers as a dependency with, e.g. `yarn add @xenova/transformers`"
+        "Please install chromadb-default-embed as a dependency with, e.g. `yarn add chromadb-default-embed`"
       );
     }
   }
@@ -2042,7 +2042,7 @@ var ChromaClient = class {
     embeddingFunction
   }) {
     if (embeddingFunction === void 0) {
-      embeddingFunction = new TransformersEmbeddingFunction();
+      embeddingFunction = new DefaultEmbeddingFunction();
     }
     const newCollection = await this.api.createCollection({
       name,
@@ -2080,7 +2080,7 @@ var ChromaClient = class {
     embeddingFunction
   }) {
     if (embeddingFunction === void 0) {
-      embeddingFunction = new TransformersEmbeddingFunction();
+      embeddingFunction = new DefaultEmbeddingFunction();
     }
     const newCollection = await this.api.createCollection({
       name,
@@ -2305,6 +2305,78 @@ var CohereEmbeddingFunction = class _CohereEmbeddingFunction {
   }
 };
 
+// src/embeddings/TransformersEmbeddingFunction.ts
+var TransformersApi2;
+var TransformersEmbeddingFunction = class _TransformersEmbeddingFunction {
+  /**
+   * TransformersEmbeddingFunction constructor.
+   * @param options The configuration options.
+   * @param options.model The model to use to calculate embeddings. Defaults to 'Xenova/all-MiniLM-L6-v2', which is an ONNX port of `sentence-transformers/all-MiniLM-L6-v2`.
+   * @param options.revision The specific model version to use (can be a branch, tag name, or commit id). Defaults to 'main'.
+   * @param options.quantized Whether to load the 8-bit quantized version of the model. Defaults to `false`.
+   * @param options.progress_callback If specified, this function will be called during model construction, to provide the user with progress updates.
+   */
+  constructor({
+    model = "Xenova/all-MiniLM-L6-v2",
+    revision = "main",
+    quantized = false,
+    progress_callback = null
+  } = {}) {
+    this.model = model;
+    this.revision = revision;
+    this.quantized = quantized;
+    this.progress_callback = progress_callback;
+  }
+  async generate(texts) {
+    await this.loadClient();
+    this.pipelinePromise = new Promise(async (resolve, reject) => {
+      try {
+        const pipeline = this.transformersApi;
+        const quantized = this.quantized;
+        const revision = this.revision;
+        const progress_callback = this.progress_callback;
+        resolve(
+          await pipeline("feature-extraction", this.model, {
+            quantized,
+            revision,
+            progress_callback
+          })
+        );
+      } catch (e) {
+        reject(e);
+      }
+    });
+    let pipe = await this.pipelinePromise;
+    let output = await pipe(texts, { pooling: "mean", normalize: true });
+    return output.tolist();
+  }
+  async loadClient() {
+    if (this.transformersApi)
+      return;
+    try {
+      let { pipeline } = await _TransformersEmbeddingFunction.import();
+      TransformersApi2 = pipeline;
+    } catch (_a) {
+      if (_a.code === "MODULE_NOT_FOUND") {
+        throw new Error("Please install the @xenova/transformers package to use the TransformersEmbeddingFunction, `npm install -S @xenova/transformers`");
+      }
+      throw _a;
+    }
+    this.transformersApi = TransformersApi2;
+  }
+  /** @ignore */
+  static async import() {
+    try {
+      const { pipeline } = await import("@xenova/transformers");
+      return { pipeline };
+    } catch (e) {
+      throw new Error(
+        "Please install @xenova/transformers as a dependency with, e.g. `yarn add @xenova/transformers`"
+      );
+    }
+  }
+};
+
 // src/types.ts
 var IncludeEnum = /* @__PURE__ */ ((IncludeEnum2) => {
   IncludeEnum2["Documents"] = "documents";
@@ -2317,6 +2389,7 @@ export {
   ChromaClient,
   CohereEmbeddingFunction,
   Collection,
+  DefaultEmbeddingFunction,
   IncludeEnum,
   OpenAIEmbeddingFunction,
   TransformersEmbeddingFunction