chromadb 3.4.1 → 3.4.3

package/dist/chromadb.d.ts

@@ -1492,6 +1492,13 @@ declare class ChromaClient {
      * @throws Error if the collection does not exist
      */
     getCollectionByCrn(crn: string): Promise<Collection>;
+    /**
+     * Retrieves an existing collection by its ID.
+     * @param id - The UUID of the collection to retrieve
+     * @returns Promise resolving to the Collection instance
+     * @throws Error if the collection does not exist
+     */
+    getCollectionById(id: string): Promise<Collection>;
     /**
      * Retrieves multiple collections by name.
      * @param items - Array of collection names or objects with name and optional embedding function (should match the ones used to create the collections)

package/dist/chromadb.legacy-esm.js

@@ -436,6 +436,22 @@ var CollectionService = class {
       }
     });
   }
+  /**
+   * Get collection by ID
+   * Returns a collection by its UUID within a specific tenant and database.
+   */
+  static getCollectionById(options) {
+    return (options.client ?? client).get({
+      security: [
+        {
+          name: "x-chroma-token",
+          type: "apiKey"
+        }
+      ],
+      url: "/api/v2/tenants/{tenant}/databases/{database}/collections/by-id/{collection_id}",
+      ...options
+    });
+  }
   /**
    * Delete collection
    * Deletes a collection in a database.
@@ -5109,6 +5125,36 @@ var ChromaClient = class {
       schema
     });
   }
+  /**
+   * Retrieves an existing collection by its ID.
+   * @param id - The UUID of the collection to retrieve
+   * @returns Promise resolving to the Collection instance
+   * @throws Error if the collection does not exist
+   */
+  async getCollectionById(id) {
+    const { data } = await CollectionService.getCollectionById({
+      client: this.apiClient,
+      path: { ...await this._path(), collection_id: id }
+    });
+    const schema = await Schema.deserializeFromJSON(data.schema ?? null, this);
+    const schemaEmbeddingFunction = resolveSchemaEmbeddingFunction(schema);
+    const resolvedEmbeddingFunction = await getEmbeddingFunction({
+      efConfig: data.configuration_json.embedding_function ?? void 0,
+      client: this
+    }) ?? schemaEmbeddingFunction;
+    return new CollectionImpl({
+      chromaClient: this,
+      apiClient: this.apiClient,
+      name: data.name,
+      tenant: data.tenant,
+      database: data.database,
+      configuration: data.configuration_json,
+      metadata: deserializeMetadata(data.metadata ?? void 0) ?? void 0,
+      embeddingFunction: resolvedEmbeddingFunction,
+      id: data.id,
+      schema
+    });
+  }
   /**
    * Retrieves multiple collections by name.
    * @param items - Array of collection names or objects with name and optional embedding function (should match the ones used to create the collections)

package/dist/chromadb.mjs

@@ -436,6 +436,22 @@ var CollectionService = class {
       }
     });
   }
+  /**
+   * Get collection by ID
+   * Returns a collection by its UUID within a specific tenant and database.
+   */
+  static getCollectionById(options) {
+    return (options.client ?? client).get({
+      security: [
+        {
+          name: "x-chroma-token",
+          type: "apiKey"
+        }
+      ],
+      url: "/api/v2/tenants/{tenant}/databases/{database}/collections/by-id/{collection_id}",
+      ...options
+    });
+  }
   /**
    * Delete collection
    * Deletes a collection in a database.
@@ -5109,6 +5125,36 @@ var ChromaClient = class {
       schema
     });
   }
+  /**
+   * Retrieves an existing collection by its ID.
+   * @param id - The UUID of the collection to retrieve
+   * @returns Promise resolving to the Collection instance
+   * @throws Error if the collection does not exist
+   */
+  async getCollectionById(id) {
+    const { data } = await CollectionService.getCollectionById({
+      client: this.apiClient,
+      path: { ...await this._path(), collection_id: id }
+    });
+    const schema = await Schema.deserializeFromJSON(data.schema ?? null, this);
+    const schemaEmbeddingFunction = resolveSchemaEmbeddingFunction(schema);
+    const resolvedEmbeddingFunction = await getEmbeddingFunction({
+      efConfig: data.configuration_json.embedding_function ?? void 0,
+      client: this
+    }) ?? schemaEmbeddingFunction;
+    return new CollectionImpl({
+      chromaClient: this,
+      apiClient: this.apiClient,
+      name: data.name,
+      tenant: data.tenant,
+      database: data.database,
+      configuration: data.configuration_json,
+      metadata: deserializeMetadata(data.metadata ?? void 0) ?? void 0,
+      embeddingFunction: resolvedEmbeddingFunction,
+      id: data.id,
+      schema
+    });
+  }
   /**
    * Retrieves multiple collections by name.
    * @param items - Array of collection names or objects with name and optional embedding function (should match the ones used to create the collections)