chromadb 3.1.5 → 3.1.7

package/dist/chromadb.d.ts

@@ -174,6 +174,12 @@ type Key$1 = 'Document' | 'Embedding' | 'Metadata' | 'Score' | {
  * This represents the server-side schema structure used for index management
  */
 type Schema$1 = {
+    /**
+     * Customer-managed encryption key for collection data
+     */
+    cmek?: {
+        [key: string]: unknown;
+    } | null;
     /**
      * Default index configurations for each value type
      */
@@ -258,6 +264,10 @@ type SparseVector = {
      * Dimension indices
      */
     indices: Array<number>;
+    /**
+     * Tokens corresponding to each index
+     */
+    tokens?: Array<string> | null;
     /**
      * Values corresponding to each index
      */
@@ -579,7 +589,7 @@ interface EmbeddingFunction {
     /** Returns all supported vector spaces for this embedding function */
     supportedSpaces?(): EmbeddingFunctionSpace[];
     /** Creates an instance from configuration object */
-    buildFromConfig?(config: Record<string, any>): EmbeddingFunction;
+    buildFromConfig?(config: Record<string, any>, client?: ChromaClient): EmbeddingFunction;
     /** Returns the current configuration as an object */
     getConfig?(): Record<string, any>;
     /**
@@ -616,7 +626,7 @@ interface SparseEmbeddingFunction {
     /** Optional name identifier for the embedding function */
     name?: string;
     /** Creates an instance from configuration object */
-    buildFromConfig?(config: Record<string, any>): SparseEmbeddingFunction;
+    buildFromConfig?(config: Record<string, any>, client?: ChromaClient): SparseEmbeddingFunction;
     /** Returns the current configuration as an object */
     getConfig?(): Record<string, any>;
     /**
@@ -640,7 +650,7 @@ interface EmbeddingFunctionClass {
     /** Name identifier for the embedding function */
     name: string;
     /** Static method to build instance from configuration */
-    buildFromConfig(config: Record<string, any>): EmbeddingFunction;
+    buildFromConfig(config: Record<string, any>, client?: ChromaClient): EmbeddingFunction;
 }
 /**
  * Interface for sparse embedding function constructor classes.
@@ -652,7 +662,7 @@ interface SparseEmbeddingFunctionClass {
     /** Name identifier for the embedding function */
     name: string;
     /** Static method to build instance from configuration */
-    buildFromConfig(config: Record<string, any>): SparseEmbeddingFunction;
+    buildFromConfig(config: Record<string, any>, client?: ChromaClient): SparseEmbeddingFunction;
 }
 /**
  * Registry of available embedding functions.
@@ -684,18 +694,18 @@ declare const registerEmbeddingFunction: (name: string, fn: EmbeddingFunctionCla
 declare const registerSparseEmbeddingFunction: (name: string, fn: SparseEmbeddingFunctionClass) => void;
 /**
  * Retrieves and instantiates an embedding function from configuration.
- * @param collectionName - Name of the collection (for error messages)
- * @param efConfig - Configuration for the embedding function
  * @returns EmbeddingFunction instance or undefined if it cannot be constructed
  */
-declare const getEmbeddingFunction: (collectionName: string, efConfig?: EmbeddingFunctionConfiguration) => Promise<EmbeddingFunction | undefined>;
+declare const getEmbeddingFunction: (args: {
+    collectionName: string;
+    client: ChromaClient;
+    efConfig?: EmbeddingFunctionConfiguration;
+}) => Promise<EmbeddingFunction | undefined>;
 /**
  * Retrieves and instantiates a sparse embedding function from configuration.
- * @param collectionName - Name of the collection (for error messages)
- * @param efConfig - Configuration for the sparse embedding function
  * @returns SparseEmbeddingFunction instance or undefined if it cannot be constructed
  */
-declare const getSparseEmbeddingFunction: (collectionName: string, efConfig?: EmbeddingFunctionConfiguration) => Promise<SparseEmbeddingFunction | undefined>;
+declare const getSparseEmbeddingFunction: (collectionName: string, client: ChromaClient, efConfig?: EmbeddingFunctionConfiguration) => Promise<SparseEmbeddingFunction | undefined>;
 /**
  * Serializes an embedding function to configuration format.
  * @param embeddingFunction - User provided embedding function
@@ -1001,7 +1011,7 @@ declare class Schema {
     createIndex(config?: IndexConfig, key?: string): this;
     deleteIndex(config?: IndexConfig, key?: string): this;
     serializeToJSON(): Schema$1;
-    static deserializeFromJSON(json?: Schema$1 | JsonDict | null): Promise<Schema | undefined>;
+    static deserializeFromJSON(json: Schema$1 | JsonDict | null, client: ChromaClient): Promise<Schema | undefined>;
     private setVectorIndexConfig;
     private setFtsIndexConfig;
     private setIndexInDefaults;
@@ -1075,11 +1085,12 @@ declare const processCreateCollectionConfig: ({ configuration, embeddingFunction
 /**
  *
  */
-declare const processUpdateCollectionConfig: ({ collectionName, currentConfiguration, currentEmbeddingFunction, newConfiguration, }: {
+declare const processUpdateCollectionConfig: ({ collectionName, currentConfiguration, currentEmbeddingFunction, newConfiguration, client, }: {
     collectionName: string;
     currentConfiguration: CollectionConfiguration;
     currentEmbeddingFunction?: EmbeddingFunction;
     newConfiguration: UpdateCollectionConfiguration;
+    client: ChromaClient;
 }) => Promise<{
     updateConfiguration?: UpdateCollectionConfiguration$1;
     updateEmbeddingFunction?: EmbeddingFunction;
@@ -1116,6 +1127,7 @@ declare class ChromaClient {
     private _tenant;
     private _database;
     private _preflightChecks;
+    private _headers;
     private readonly apiClient;
     /**
      * Creates a new ChromaClient instance.
@@ -1140,6 +1152,7 @@ declare class ChromaClient {
      */
     get preflightChecks(): ChecklistResponse | undefined;
     protected set preflightChecks(preflightChecks: ChecklistResponse | undefined);
+    get headers(): Record<string, string> | undefined;
     /** @ignore */
     _path(): Promise<{
         tenant: string;
@@ -1200,6 +1213,13 @@ declare class ChromaClient {
         name: string;
         embeddingFunction?: EmbeddingFunction;
     }): Promise<Collection>;
+    /**
+     * Retrieves an existing collection by its Chroma Resource Name (CRN).
+     * @param crn - The Chroma Resource Name of the collection to retrieve
+     * @returns Promise resolving to the Collection instance
+     * @throws Error if the collection does not exist
+     */
+    getCollectionByCrn(crn: 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)
@@ -1266,6 +1286,10 @@ declare class ChromaClient {
  * Provides methods for adding, querying, updating, and deleting records.
  */
 interface Collection {
+    /** Tenant name */
+    tenant: string;
+    /** Database name */
+    database: string;
     /** Unique identifier for the collection */
     id: string;
     /** Name of the collection */
@@ -1528,6 +1552,10 @@ declare class CloudClient extends ChromaClient {
     constructor(args?: Partial<{
         /** API key for authentication (or set CHROMA_API_KEY env var) */
         apiKey?: string;
+        /** Host address of the Chroma cloud server. Defaults to 'api.trychroma.com' */
+        host?: string;
+        /** Port number of the Chroma cloud server. Defaults to 443 */
+        port?: number;
         /** Tenant name for multi-tenant deployments */
         tenant?: string;
         /** Database name to connect to */
@@ -1548,6 +1576,10 @@ declare class AdminCloudClient extends AdminClient {
     constructor(args?: Partial<{
         /** API key for authentication (or set CHROMA_API_KEY env var) */
         apiKey?: string;
+        /** Host address of the Chroma cloud server. Defaults to 'api.trychroma.com' */
+        host?: string;
+        /** Port number of the Chroma cloud server. Defaults to 443 */
+        port?: number;
         /** Additional fetch options for HTTP requests */
         fetchOptions?: RequestInit;
     }>);