chromadb 1.10.3 → 1.10.5

package/dist/chromadb.d.ts

@@ -2,6 +2,7 @@ import * as openai from 'openai';
 import * as _xenova_transformers from '@xenova/transformers';
 import * as chromadb_default_embed from 'chromadb-default-embed';
 import * as _google_generative_ai from '@google/generative-ai';
+import * as ollama from 'ollama';
 
 interface IEmbeddingFunction {
     generate(texts: string[]): Promise<number[][]>;
@@ -1433,7 +1434,7 @@ declare class ChromaClient {
      */
     getOrCreateCollection({ name, metadata, embeddingFunction, }: GetOrCreateCollectionParams): Promise<Collection>;
     /**
-     * Lists all collections.
+     * Get all collection names.
      *
      * @returns {Promise<string[]>} A promise that resolves to a list of collection names.
      * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
@@ -1449,6 +1450,26 @@ declare class ChromaClient {
      * ```
      */
     listCollections({ limit, offset }?: ListCollectionsParams): Promise<string[]>;
+    /**
+     * List collection names, IDs, and metadata.
+     *
+     * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
+     * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
+     * @throws {Error} If there is an issue listing the collections.
+     * @returns {Promise<{ name: string, id: string, metadata?: CollectionMetadata }[]>} A promise that resolves to a list of collection names, IDs, and metadata.
+     *
+     * @example
+     * ```typescript
+     * const collections = await client.listCollectionsAndMetadata({
+     *    limit: 10,
+     *    offset: 0,
+     * });
+     */
+    listCollectionsAndMetadata({ limit, offset, }?: ListCollectionsParams): Promise<{
+        name: string;
+        id: string;
+        metadata?: CollectionMetadata;
+    }[]>;
     /**
      * Counts all collections.
      *
@@ -1498,6 +1519,8 @@ interface Tenant {
     name: string;
 }
 interface Database {
+    id: string;
+    tenant: string;
     name: string;
 }
 declare class AdminClient {
@@ -1628,7 +1651,9 @@ declare class AdminClient {
     createDatabase({ name, tenantName, }: {
         name: string;
         tenantName: string;
-    }): Promise<Database>;
+    }): Promise<{
+        name: string;
+    }>;
     /**
      * Gets a database with the specified properties.
      *
@@ -1822,13 +1847,85 @@ declare class GoogleGenerativeAiEmbeddingFunction implements IEmbeddingFunction
 }
 
 declare class OllamaEmbeddingFunction implements IEmbeddingFunction {
-    private readonly url;
+    private readonly url?;
     private readonly model;
-    constructor({ url, model }: {
-        url: string;
-        model: string;
+    private ollamaClient;
+    constructor({ url, model, }?: {
+        url?: string;
+        model?: string;
     });
-    generate(texts: string[]): Promise<number[][]>;
+    private initClient;
+    /** @ignore */
+    static import(): Promise<{
+        ollama: typeof ollama;
+    }>;
+    generate(texts: string[]): Promise<any>;
+}
+
+/**
+ * This is a generic Chroma error.
+ */
+declare class ChromaError extends Error {
+    readonly cause?: unknown | undefined;
+    constructor(name: string, message: string, cause?: unknown | undefined);
+}
+/**
+ * Indicates that there was a problem with the connection to the Chroma server (e.g. the server is down or the client is not connected to the internet)
+ */
+declare class ChromaConnectionError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** Indicates that the server encountered an error while handling the request. */
+declare class ChromaServerError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** Indicate that there was an issue with the request that the client made. */
+declare class ChromaClientError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** The request lacked valid authentication. */
+declare class ChromaUnauthorizedError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+/** The user does not have permission to access the requested resource. */
+declare class ChromaForbiddenError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+declare class ChromaNotFoundError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+declare class ChromaValueError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+declare class InvalidCollectionError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+declare class InvalidArgumentError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
+}
+declare class ChromaUniqueError extends Error {
+    readonly cause?: unknown | undefined;
+    name: string;
+    constructor(message: string, cause?: unknown | undefined);
 }
+declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
 
-export { type AddRecordsParams, AdminClient, ChromaClient, type ChromaClientParams, CloudClient, CohereEmbeddingFunction, Collection, type CollectionMetadata, type CollectionParams, type CreateCollectionParams, DefaultEmbeddingFunction, type DeleteCollectionParams, type DeleteParams, type Document, type Documents, type Embedding, type Embeddings, type GetCollectionParams, type GetOrCreateCollectionParams, type GetParams, type GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, type ID, type IDs, type IEmbeddingFunction, IncludeEnum, JinaEmbeddingFunction, type ListCollectionsParams, type Metadata, type Metadatas, type ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, type PeekParams, type QueryRecordsParams, type QueryResponse, TransformersEmbeddingFunction, type UpdateRecordsParams, type UpsertRecordsParams, type Where, type WhereDocument };
+export { AddRecordsParams, AdminClient, ChromaClient, ChromaClientError, ChromaClientParams, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, CohereEmbeddingFunction, Collection, CollectionMetadata, CollectionParams, CreateCollectionParams, DefaultEmbeddingFunction, DeleteCollectionParams, DeleteParams, Document, Documents, Embedding, Embeddings, GetCollectionParams, GetOrCreateCollectionParams, GetParams, GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, ID, IDs, IEmbeddingFunction, IncludeEnum, InvalidArgumentError, InvalidCollectionError, JinaEmbeddingFunction, ListCollectionsParams, Metadata, Metadatas, ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, PeekParams, QueryRecordsParams, QueryResponse, TransformersEmbeddingFunction, UpdateRecordsParams, UpsertRecordsParams, Where, WhereDocument, createErrorByType };

package/dist/chromadb.legacy-esm.js

@@ -3386,15 +3386,15 @@ var ApiApi = class extends BaseAPI {
 // src/generated/models.ts
 var Api;
 ((Api2) => {
-  let IncludeEnum;
-  ((IncludeEnum2) => {
-    IncludeEnum2["Documents"] = "documents";
-    IncludeEnum2["Embeddings"] = "embeddings";
-    IncludeEnum2["Metadatas"] = "metadatas";
-    IncludeEnum2["Distances"] = "distances";
-    IncludeEnum2["Uris"] = "uris";
-    IncludeEnum2["Data"] = "data";
-  })(IncludeEnum = Api2.IncludeEnum || (Api2.IncludeEnum = {}));
+  let IncludeEnum2;
+  ((IncludeEnum3) => {
+    IncludeEnum3["Documents"] = "documents";
+    IncludeEnum3["Embeddings"] = "embeddings";
+    IncludeEnum3["Metadatas"] = "metadatas";
+    IncludeEnum3["Distances"] = "distances";
+    IncludeEnum3["Uris"] = "uris";
+    IncludeEnum3["Data"] = "data";
+  })(IncludeEnum2 = Api2.IncludeEnum || (Api2.IncludeEnum = {}));
 })(Api || (Api = {}));
 
 // src/generated/configuration.ts
@@ -4267,12 +4267,12 @@ var AdminClient = class {
     name,
     tenantName
   }) {
-    const getDatabase = await this.api.getDatabase(
+    const result = await this.api.getDatabase(
       name,
       tenantName,
       this.api.options
     );
-    return { name: getDatabase.name };
+    return result;
   }
   /**
    * Deletes a database.
@@ -4305,13 +4305,12 @@ var AdminClient = class {
     offset,
     tenantName
   }) {
-    const listDatabases = await this.api.listDatabases(
+    return await this.api.listDatabases(
       tenantName,
       limit,
       offset,
       this.api.options
     );
-    return listDatabases.map((db) => ({ name: db.name }));
   }
 };
 
@@ -4382,9 +4381,8 @@ var DefaultEmbeddingFunction = class _DefaultEmbeddingFunction {
       let importResult;
       if (isBrowser()) {
         importResult = await import(
-          // todo: we can't import chromadb-default-embed here yet because the `build` script was not run before publishing our fork to NPM, so the entrypoint in our forked package points to a non-existent file.
           // @ts-expect-error
-          "https://unpkg.com/@xenova/transformers@2.13.2"
+          "https://unpkg.com/chromadb-default-embed@2.14.0"
         );
       } else {
         importResult = await import("chromadb-default-embed");
@@ -4616,7 +4614,7 @@ var ChromaClient = class {
     });
   }
   /**
-   * Lists all collections.
+   * Get all collection names.
    *
    * @returns {Promise<string[]>} A promise that resolves to a list of collection names.
    * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
@@ -4642,6 +4640,34 @@ var ChromaClient = class {
     );
     return collections.map((collection) => collection.name);
   }
+  /**
+   * List collection names, IDs, and metadata.
+   *
+   * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
+   * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
+   * @throws {Error} If there is an issue listing the collections.
+   * @returns {Promise<{ name: string, id: string, metadata?: CollectionMetadata }[]>} A promise that resolves to a list of collection names, IDs, and metadata.
+   *
+   * @example
+   * ```typescript
+   * const collections = await client.listCollectionsAndMetadata({
+   *    limit: 10,
+   *    offset: 0,
+   * });
+   */
+  async listCollectionsAndMetadata({
+    limit,
+    offset
+  } = {}) {
+    await this.init();
+    return await this.api.listCollections(
+      this.tenant,
+      this.database,
+      limit,
+      offset,
+      this.api.options
+    );
+  }
   /**
    * Counts all collections.
    *
@@ -5130,44 +5156,93 @@ var GoogleGenerativeAiEmbeddingFunction = class _GoogleGenerativeAiEmbeddingFunc
 };
 
 // src/embeddings/OllamaEmbeddingFunction.ts
-var OllamaEmbeddingFunction = class {
-  constructor({ url, model }) {
-    this.url = url;
-    this.model = model;
+var DEFAULT_MODEL = "chroma/all-minilm-l6-v2-f32";
+var DEFAULT_LOCAL_URL = "http://localhost:11434";
+var OllamaEmbeddingFunction = class _OllamaEmbeddingFunction {
+  constructor({
+    url = DEFAULT_LOCAL_URL,
+    model = DEFAULT_MODEL
+  } = {
+    url: DEFAULT_LOCAL_URL,
+    model: DEFAULT_MODEL
+  }) {
+    if (url && url.endsWith("/api/embeddings")) {
+      this.url = url.slice(0, -"/api/embeddings".length);
+    } else {
+      this.url = url || DEFAULT_LOCAL_URL;
+    }
+    this.model = model || DEFAULT_MODEL;
   }
-  async generate(texts) {
-    let embeddings = [];
-    for (let text of texts) {
-      const response = await fetch(this.url, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
-        },
-        body: JSON.stringify({ model: this.model, prompt: text })
-      });
-      if (!response.ok) {
+  async initClient() {
+    if (this.ollamaClient)
+      return;
+    try {
+      const { ollama } = await _OllamaEmbeddingFunction.import();
+      this.ollamaClient = new ollama.Ollama({ host: this.url });
+    } catch (e) {
+      if (e.code === "MODULE_NOT_FOUND") {
         throw new Error(
-          `Failed to generate embeddings: ${response.status} (${response.statusText})`
+          "Please install the ollama package to use the OllamaEmbeddingFunction, `npm install -S ollama`"
         );
       }
-      let finalResponse = await response.json();
-      embeddings.push(finalResponse["embedding"]);
+      throw e;
     }
-    return embeddings;
+  }
+  /** @ignore */
+  static async import() {
+    try {
+      const { ollama } = await import("ollama").then((m) => ({ ollama: m }));
+      return { ollama };
+    } catch (e) {
+      throw new Error(
+        "Please install Ollama as a dependency with, e.g. `npm install ollama`"
+      );
+    }
+  }
+  async generate(texts) {
+    await this.initClient();
+    return await this.ollamaClient.embed({
+      model: this.model,
+      input: texts
+    }).then((response) => {
+      return response.embeddings;
+    });
   }
 };
+
+// src/types.ts
+var IncludeEnum = /* @__PURE__ */ ((IncludeEnum2) => {
+  IncludeEnum2["Documents"] = "documents";
+  IncludeEnum2["Embeddings"] = "embeddings";
+  IncludeEnum2["Metadatas"] = "metadatas";
+  IncludeEnum2["Distances"] = "distances";
+  return IncludeEnum2;
+})(IncludeEnum || {});
 export {
   AdminClient,
   ChromaClient,
+  ChromaClientError,
+  ChromaConnectionError,
+  ChromaError,
+  ChromaForbiddenError,
+  ChromaNotFoundError,
+  ChromaServerError,
+  ChromaUnauthorizedError,
+  ChromaUniqueError,
+  ChromaValueError,
   CloudClient,
   CohereEmbeddingFunction,
   Collection,
   DefaultEmbeddingFunction,
   GoogleGenerativeAiEmbeddingFunction,
   HuggingFaceEmbeddingServerFunction,
+  IncludeEnum,
+  InvalidArgumentError,
+  InvalidCollectionError,
   JinaEmbeddingFunction,
   OllamaEmbeddingFunction,
   OpenAIEmbeddingFunction,
-  TransformersEmbeddingFunction
+  TransformersEmbeddingFunction,
+  createErrorByType
 };
 //# sourceMappingURL=chromadb.mjs.map

package/dist/chromadb.mjs

@@ -3386,15 +3386,15 @@ var ApiApi = class extends BaseAPI {
 // src/generated/models.ts
 var Api;
 ((Api2) => {
-  let IncludeEnum;
-  ((IncludeEnum2) => {
-    IncludeEnum2["Documents"] = "documents";
-    IncludeEnum2["Embeddings"] = "embeddings";
-    IncludeEnum2["Metadatas"] = "metadatas";
-    IncludeEnum2["Distances"] = "distances";
-    IncludeEnum2["Uris"] = "uris";
-    IncludeEnum2["Data"] = "data";
-  })(IncludeEnum = Api2.IncludeEnum || (Api2.IncludeEnum = {}));
+  let IncludeEnum2;
+  ((IncludeEnum3) => {
+    IncludeEnum3["Documents"] = "documents";
+    IncludeEnum3["Embeddings"] = "embeddings";
+    IncludeEnum3["Metadatas"] = "metadatas";
+    IncludeEnum3["Distances"] = "distances";
+    IncludeEnum3["Uris"] = "uris";
+    IncludeEnum3["Data"] = "data";
+  })(IncludeEnum2 = Api2.IncludeEnum || (Api2.IncludeEnum = {}));
 })(Api || (Api = {}));
 
 // src/generated/configuration.ts
@@ -4267,12 +4267,12 @@ var AdminClient = class {
     name,
     tenantName
   }) {
-    const getDatabase = await this.api.getDatabase(
+    const result = await this.api.getDatabase(
       name,
       tenantName,
       this.api.options
     );
-    return { name: getDatabase.name };
+    return result;
   }
   /**
    * Deletes a database.
@@ -4305,13 +4305,12 @@ var AdminClient = class {
     offset,
     tenantName
   }) {
-    const listDatabases = await this.api.listDatabases(
+    return await this.api.listDatabases(
       tenantName,
       limit,
       offset,
       this.api.options
     );
-    return listDatabases.map((db) => ({ name: db.name }));
   }
 };
 
@@ -4382,9 +4381,8 @@ var DefaultEmbeddingFunction = class _DefaultEmbeddingFunction {
       let importResult;
       if (isBrowser()) {
         importResult = await import(
-          // todo: we can't import chromadb-default-embed here yet because the `build` script was not run before publishing our fork to NPM, so the entrypoint in our forked package points to a non-existent file.
           // @ts-expect-error
-          "https://unpkg.com/@xenova/transformers@2.13.2"
+          "https://unpkg.com/chromadb-default-embed@2.14.0"
         );
       } else {
         importResult = await import("chromadb-default-embed");
@@ -4616,7 +4614,7 @@ var ChromaClient = class {
     });
   }
   /**
-   * Lists all collections.
+   * Get all collection names.
    *
    * @returns {Promise<string[]>} A promise that resolves to a list of collection names.
    * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
@@ -4642,6 +4640,34 @@ var ChromaClient = class {
     );
     return collections.map((collection) => collection.name);
   }
+  /**
+   * List collection names, IDs, and metadata.
+   *
+   * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
+   * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
+   * @throws {Error} If there is an issue listing the collections.
+   * @returns {Promise<{ name: string, id: string, metadata?: CollectionMetadata }[]>} A promise that resolves to a list of collection names, IDs, and metadata.
+   *
+   * @example
+   * ```typescript
+   * const collections = await client.listCollectionsAndMetadata({
+   *    limit: 10,
+   *    offset: 0,
+   * });
+   */
+  async listCollectionsAndMetadata({
+    limit,
+    offset
+  } = {}) {
+    await this.init();
+    return await this.api.listCollections(
+      this.tenant,
+      this.database,
+      limit,
+      offset,
+      this.api.options
+    );
+  }
   /**
    * Counts all collections.
    *
@@ -5130,44 +5156,93 @@ var GoogleGenerativeAiEmbeddingFunction = class _GoogleGenerativeAiEmbeddingFunc
 };
 
 // src/embeddings/OllamaEmbeddingFunction.ts
-var OllamaEmbeddingFunction = class {
-  constructor({ url, model }) {
-    this.url = url;
-    this.model = model;
+var DEFAULT_MODEL = "chroma/all-minilm-l6-v2-f32";
+var DEFAULT_LOCAL_URL = "http://localhost:11434";
+var OllamaEmbeddingFunction = class _OllamaEmbeddingFunction {
+  constructor({
+    url = DEFAULT_LOCAL_URL,
+    model = DEFAULT_MODEL
+  } = {
+    url: DEFAULT_LOCAL_URL,
+    model: DEFAULT_MODEL
+  }) {
+    if (url && url.endsWith("/api/embeddings")) {
+      this.url = url.slice(0, -"/api/embeddings".length);
+    } else {
+      this.url = url || DEFAULT_LOCAL_URL;
+    }
+    this.model = model || DEFAULT_MODEL;
   }
-  async generate(texts) {
-    let embeddings = [];
-    for (let text of texts) {
-      const response = await fetch(this.url, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json"
-        },
-        body: JSON.stringify({ model: this.model, prompt: text })
-      });
-      if (!response.ok) {
+  async initClient() {
+    if (this.ollamaClient)
+      return;
+    try {
+      const { ollama } = await _OllamaEmbeddingFunction.import();
+      this.ollamaClient = new ollama.Ollama({ host: this.url });
+    } catch (e) {
+      if (e.code === "MODULE_NOT_FOUND") {
         throw new Error(
-          `Failed to generate embeddings: ${response.status} (${response.statusText})`
+          "Please install the ollama package to use the OllamaEmbeddingFunction, `npm install -S ollama`"
         );
       }
-      let finalResponse = await response.json();
-      embeddings.push(finalResponse["embedding"]);
+      throw e;
     }
-    return embeddings;
+  }
+  /** @ignore */
+  static async import() {
+    try {
+      const { ollama } = await import("ollama").then((m) => ({ ollama: m }));
+      return { ollama };
+    } catch (e) {
+      throw new Error(
+        "Please install Ollama as a dependency with, e.g. `npm install ollama`"
+      );
+    }
+  }
+  async generate(texts) {
+    await this.initClient();
+    return await this.ollamaClient.embed({
+      model: this.model,
+      input: texts
+    }).then((response) => {
+      return response.embeddings;
+    });
   }
 };
+
+// src/types.ts
+var IncludeEnum = /* @__PURE__ */ ((IncludeEnum2) => {
+  IncludeEnum2["Documents"] = "documents";
+  IncludeEnum2["Embeddings"] = "embeddings";
+  IncludeEnum2["Metadatas"] = "metadatas";
+  IncludeEnum2["Distances"] = "distances";
+  return IncludeEnum2;
+})(IncludeEnum || {});
 export {
   AdminClient,
   ChromaClient,
+  ChromaClientError,
+  ChromaConnectionError,
+  ChromaError,
+  ChromaForbiddenError,
+  ChromaNotFoundError,
+  ChromaServerError,
+  ChromaUnauthorizedError,
+  ChromaUniqueError,
+  ChromaValueError,
   CloudClient,
   CohereEmbeddingFunction,
   Collection,
   DefaultEmbeddingFunction,
   GoogleGenerativeAiEmbeddingFunction,
   HuggingFaceEmbeddingServerFunction,
+  IncludeEnum,
+  InvalidArgumentError,
+  InvalidCollectionError,
   JinaEmbeddingFunction,
   OllamaEmbeddingFunction,
   OpenAIEmbeddingFunction,
-  TransformersEmbeddingFunction
+  TransformersEmbeddingFunction,
+  createErrorByType
 };
 //# sourceMappingURL=chromadb.mjs.map