chromadb 3.4.1 → 3.4.3

package/dist/cjs/chromadb.d.cts

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromadb",
-  "version": "3.4.1",
+  "version": "3.4.3",
   "description": "A JavaScript interface for chroma",
   "keywords": [
     "chroma",
@@ -60,11 +60,11 @@
     "@chroma-core/default-embed": "^0.1.9"
   },
   "optionalDependencies": {
-    "chromadb-js-bindings-darwin-arm64": "^1.3.2",
-    "chromadb-js-bindings-darwin-x64": "^1.3.2",
-    "chromadb-js-bindings-linux-arm64-gnu": "^1.3.2",
-    "chromadb-js-bindings-linux-x64-gnu": "^1.3.2",
-    "chromadb-js-bindings-win32-x64-msvc": "^1.3.2"
+    "chromadb-js-bindings-darwin-arm64": "^1.3.3",
+    "chromadb-js-bindings-darwin-x64": "^1.3.3",
+    "chromadb-js-bindings-linux-arm64-gnu": "^1.3.3",
+    "chromadb-js-bindings-linux-x64-gnu": "^1.3.3",
+    "chromadb-js-bindings-win32-x64-msvc": "^1.3.3"
   },
   "engines": {
     "node": ">=20"

package/src/api/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { GetUserIdentityData, GetUserIdentityResponse2, GetUserIdentityError, GetCollectionByCrnData, GetCollectionByCrnResponse, GetCollectionByCrnError, HealthcheckData, HealthcheckResponse, HealthcheckError, HeartbeatData, HeartbeatResponse2, HeartbeatError, PreFlightChecksData, PreFlightChecksResponse, PreFlightChecksError, ResetData, ResetResponse, ResetError, CreateTenantData, CreateTenantResponse2, CreateTenantError, GetTenantData, GetTenantResponse2, GetTenantError, UpdateTenantData, UpdateTenantResponse2, UpdateTenantError, ListDatabasesData, ListDatabasesResponse, ListDatabasesError, CreateDatabaseData, CreateDatabaseResponse2, CreateDatabaseError, DeleteDatabaseData, DeleteDatabaseResponse2, DeleteDatabaseError, GetDatabaseData, GetDatabaseResponse, GetDatabaseError, ListCollectionsData, ListCollectionsResponse, ListCollectionsError, CreateCollectionData, CreateCollectionResponse, CreateCollectionError, DeleteCollectionData, DeleteCollectionResponse2, DeleteCollectionError, GetCollectionData, GetCollectionResponse, GetCollectionError, UpdateCollectionData, UpdateCollectionResponse2, UpdateCollectionError, CollectionAddData, CollectionAddResponse, DetachFunctionData, DetachFunctionResponse2, DetachFunctionError, CollectionCountData, CollectionCountResponse, CollectionCountError, CollectionDeleteData, CollectionDeleteResponse, CollectionDeleteError, ForkCollectionData, ForkCollectionResponse, ForkCollectionError, ForkCountData, ForkCountResponse2, ForkCountError, AttachFunctionData, AttachFunctionResponse2, AttachFunctionError, GetAttachedFunctionData, GetAttachedFunctionResponse2, GetAttachedFunctionError, CollectionGetData, CollectionGetResponse, CollectionGetError, IndexingStatusData, IndexingStatusResponse, IndexingStatusError, CollectionQueryData, CollectionQueryResponse, CollectionQueryError, CollectionSearchData, CollectionSearchResponse, CollectionSearchError, CollectionUpdateData, CollectionUpdateResponse, CollectionUpsertData, CollectionUpsertResponse, CollectionUpsertError, CountCollectionsData, CountCollectionsResponse, CountCollectionsError, VersionData, VersionResponse } from './types.gen';
+import type { GetUserIdentityData, GetUserIdentityResponse2, GetUserIdentityError, GetCollectionByCrnData, GetCollectionByCrnResponse, GetCollectionByCrnError, HealthcheckData, HealthcheckResponse, HealthcheckError, HeartbeatData, HeartbeatResponse2, HeartbeatError, PreFlightChecksData, PreFlightChecksResponse, PreFlightChecksError, ResetData, ResetResponse, ResetError, CreateTenantData, CreateTenantResponse2, CreateTenantError, GetTenantData, GetTenantResponse2, GetTenantError, UpdateTenantData, UpdateTenantResponse2, UpdateTenantError, ListDatabasesData, ListDatabasesResponse, ListDatabasesError, CreateDatabaseData, CreateDatabaseResponse2, CreateDatabaseError, DeleteDatabaseData, DeleteDatabaseResponse2, DeleteDatabaseError, GetDatabaseData, GetDatabaseResponse, GetDatabaseError, ListCollectionsData, ListCollectionsResponse, ListCollectionsError, CreateCollectionData, CreateCollectionResponse, CreateCollectionError, GetCollectionByIdData, GetCollectionByIdResponse, GetCollectionByIdError, DeleteCollectionData, DeleteCollectionResponse2, DeleteCollectionError, GetCollectionData, GetCollectionResponse, GetCollectionError, UpdateCollectionData, UpdateCollectionResponse2, UpdateCollectionError, CollectionAddData, CollectionAddResponse, DetachFunctionData, DetachFunctionResponse2, DetachFunctionError, CollectionCountData, CollectionCountResponse, CollectionCountError, CollectionDeleteData, CollectionDeleteResponse, CollectionDeleteError, ForkCollectionData, ForkCollectionResponse, ForkCollectionError, ForkCountData, ForkCountResponse2, ForkCountError, AttachFunctionData, AttachFunctionResponse2, AttachFunctionError, GetAttachedFunctionData, GetAttachedFunctionResponse2, GetAttachedFunctionError, CollectionGetData, CollectionGetResponse, CollectionGetError, IndexingStatusData, IndexingStatusResponse, IndexingStatusError, CollectionQueryData, CollectionQueryResponse, CollectionQueryError, CollectionSearchData, CollectionSearchResponse, CollectionSearchError, CollectionUpdateData, CollectionUpdateResponse, CollectionUpsertData, CollectionUpsertResponse, CollectionUpsertError, CountCollectionsData, CountCollectionsResponse, CountCollectionsError, VersionData, VersionResponse } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -94,6 +94,23 @@ export class CollectionService {
         });
     }
     
+    /**
+     * Get collection by ID
+     * Returns a collection by its UUID within a specific tenant and database.
+     */
+    public static getCollectionById<ThrowOnError extends boolean = true>(options: Options<GetCollectionByIdData, ThrowOnError>) {
+        return (options.client ?? _heyApiClient).get<GetCollectionByIdResponse, GetCollectionByIdError, ThrowOnError>({
+            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.

package/src/api/types.gen.ts

@@ -1307,6 +1307,52 @@ export type CreateCollectionResponses = {
 
 export type CreateCollectionResponse = CreateCollectionResponses[keyof CreateCollectionResponses];
 
+export type GetCollectionByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Tenant ID
+         */
+        tenant: string;
+        /**
+         * Database name
+         */
+        database: string;
+        /**
+         * Collection UUID
+         */
+        collection_id: string;
+    };
+    query?: never;
+    url: '/api/v2/tenants/{tenant}/databases/{database}/collections/by-id/{collection_id}';
+};
+
+export type GetCollectionByIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Collection not found
+     */
+    404: ErrorResponse;
+    /**
+     * Server error
+     */
+    500: ErrorResponse;
+};
+
+export type GetCollectionByIdError = GetCollectionByIdErrors[keyof GetCollectionByIdErrors];
+
+export type GetCollectionByIdResponses = {
+    /**
+     * Collection found
+     */
+    200: Collection;
+};
+
+export type GetCollectionByIdResponse = GetCollectionByIdResponses[keyof GetCollectionByIdResponses];
+
 export type DeleteCollectionData = {
     body?: never;
     path: {

package/src/chroma-client.ts

@@ -440,6 +440,38 @@ export class ChromaClient {
     });
   }
 
+  /**
+   * 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
+   */
+  public async getCollectionById(id: string): Promise<Collection> {
+    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 ?? undefined,
+        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 ?? undefined) ?? undefined,
+      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/src/cli.ts

@@ -53,6 +53,10 @@ const main = async () => {
     return;
   }
 
+  process.on("SIGINT", () => {
+    process.exit(0);
+  });
+
   binding.cli(["chroma", ...args]);
 };