chromadb 3.3.0 → 3.3.2

package/dist/chromadb.d.ts

@@ -20,6 +20,9 @@ type Database = {
     name: string;
     tenant: string;
 };
+type DeleteCollectionRecordsResponse = {
+    deleted?: number;
+};
 type EmbeddingFunctionConfiguration = {
     type: 'legacy';
 } | (EmbeddingFunctionNewConfiguration & {
@@ -177,6 +180,10 @@ type IntValueType$1 = {
 type Key$1 = 'Document' | 'Embedding' | 'Metadata' | 'Score' | {
     MetadataField: string;
 };
+/**
+ * Quantization implementation for SPANN vector index.
+ */
+type Quantization = 'none' | 'four_bit_rabit_q_with_u_search';
 /**
  * Schema representation for collection index configurations
  *
@@ -263,9 +270,9 @@ type SpannIndexConfig = {
     num_centers_to_merge_to?: number | null;
     num_samples_kmeans?: number | null;
     /**
-     * Enable quantization for vector search (cloud-only feature)
+     * Quantization implementation for vector search (cloud-only feature)
      */
-    quantize?: boolean;
+    quantize?: Quantization;
     reassign_neighbor_count?: number | null;
     search_nprobe?: number | null;
     search_rng_epsilon?: number | null;
@@ -602,6 +609,10 @@ declare class QueryResult<TMeta extends Metadata = Metadata> {
      */
     rows(): QueryRowResult<TMeta>[][];
 }
+/**
+ * Result of a delete operation.
+ */
+type DeleteResult = DeleteCollectionRecordsResponse;
 /**
  * Re-export IndexStatusResponse type for external use
  */
@@ -1274,7 +1285,6 @@ declare class Schema {
     serializeToJSON(): Schema$1;
     static deserializeFromJSON(json: Schema$1 | JsonDict | null, client: ChromaClient): Promise<Schema | undefined>;
     private setVectorIndexConfig;
-    private setFtsIndexConfig;
     private setIndexInDefaults;
     private setIndexForKey;
     private enableAllIndexesForKey;
@@ -1563,8 +1573,18 @@ interface Collection {
     embeddingFunction?: EmbeddingFunction;
     /** Collection schema describing index configuration */
     schema?: Schema;
-    /** Gets the total number of records in the collection */
-    count(): Promise<number>;
+    /**
+     * Gets the total number of records in the collection.
+     * @param options - Optional settings
+     */
+    count(options?: {
+        /**
+         * Controls whether to read from the write-ahead log.
+         * - ReadLevel.INDEX_AND_WAL: Read from both index and WAL (default)
+         * - ReadLevel.INDEX_ONLY: Read only from index, faster but recent writes may not be visible
+         */
+        readLevel?: ReadLevel;
+    }): Promise<number>;
     /**
      * Adds new records to the collection.
      * @param args - Record data to add
@@ -1696,7 +1716,9 @@ interface Collection {
         where?: Where;
         /** Document content-based filtering for deletion */
         whereDocument?: WhereDocument;
-    }): Promise<void>;
+        /** Maximum number of records to delete. Can only be used with where or whereDocument filters. */
+        limit?: number;
+    }): Promise<DeleteResult>;
     /**
      * Performs hybrid search on the collection using expression builders.
      * @param searches - Single search payload or array of payloads
@@ -1934,4 +1956,4 @@ declare class ChromaRateLimitError extends Error {
 }
 declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
 
-export { Abs, AdminClient, type AdminClientArgs, AdminCloudClient, Aggregate, type AggregateInput, type AggregateJSON, type AnyEmbeddingFunction, type BaseRecordSet, BoolInvertedIndexConfig, BoolInvertedIndexType, BoolValueType, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaRateLimitError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, Cmek, CmekProvider, type Collection, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, DOCUMENT_KEY, Div, EMBEDDING_KEY, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, Exp, FloatInvertedIndexConfig, FloatInvertedIndexType, FloatListValueType, FloatValueType, FtsIndexConfig, FtsIndexType, GetResult, GroupBy, type GroupByInput, type GroupByJSON, type HNSWConfiguration, IncludeEnum, type IndexConfig, type IndexingStatus, IntInvertedIndexConfig, IntInvertedIndexType, IntValueType, InvalidArgumentError, InvalidCollectionError, K, Key, type KeyFactory, Knn, type KnnOptions, Limit, type LimitInput, type LimitOptions, type ListDatabasesArgs, Log, Max, MaxK, type Metadata, type MetadataScalar, Min, MinK, Mul, type PreparedInsertRecordSet, type PreparedRecordSet, type QueryRecordSet, QueryResult, type QueryRowResult, RankExpression, type RankInput, type RankLiteral, ReadLevel, type RecordSet, Rrf, type RrfOptions, Schema, Search, type SearchInit, type SearchLike, SearchResult, type SearchResultRow, Select, type SelectInput, type SelectKeyInput, type SparseEmbeddingFunction, type SparseEmbeddingFunctionClass, type SparseVector, SparseVectorIndexConfig, type SparseVectorIndexConfigOptions, SparseVectorIndexType, SparseVectorValueType, StringInvertedIndexConfig, StringInvertedIndexType, StringValueType, Sub, Sum, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, Val, ValueTypes, VectorIndexConfig, type VectorIndexConfigOptions, VectorIndexType, type Where, type WhereDocument, WhereExpression, type WhereInput, type WhereJSON, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, getSparseEmbeddingFunction, knownEmbeddingFunctions, knownSparseEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, registerSparseEmbeddingFunction, serializeEmbeddingFunction, toSearch, withChroma };
+export { Abs, AdminClient, type AdminClientArgs, AdminCloudClient, Aggregate, type AggregateInput, type AggregateJSON, type AnyEmbeddingFunction, type BaseRecordSet, BoolInvertedIndexConfig, BoolInvertedIndexType, BoolValueType, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaRateLimitError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, Cmek, CmekProvider, type Collection, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, DOCUMENT_KEY, type DeleteResult, Div, EMBEDDING_KEY, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, Exp, FloatInvertedIndexConfig, FloatInvertedIndexType, FloatListValueType, FloatValueType, FtsIndexConfig, FtsIndexType, GetResult, GroupBy, type GroupByInput, type GroupByJSON, type HNSWConfiguration, IncludeEnum, type IndexConfig, type IndexingStatus, IntInvertedIndexConfig, IntInvertedIndexType, IntValueType, InvalidArgumentError, InvalidCollectionError, K, Key, type KeyFactory, Knn, type KnnOptions, Limit, type LimitInput, type LimitOptions, type ListDatabasesArgs, Log, Max, MaxK, type Metadata, type MetadataScalar, Min, MinK, Mul, type PreparedInsertRecordSet, type PreparedRecordSet, type QueryRecordSet, QueryResult, type QueryRowResult, RankExpression, type RankInput, type RankLiteral, ReadLevel, type RecordSet, Rrf, type RrfOptions, Schema, Search, type SearchInit, type SearchLike, SearchResult, type SearchResultRow, Select, type SelectInput, type SelectKeyInput, type SparseEmbeddingFunction, type SparseEmbeddingFunctionClass, type SparseVector, SparseVectorIndexConfig, type SparseVectorIndexConfigOptions, SparseVectorIndexType, SparseVectorValueType, StringInvertedIndexConfig, StringInvertedIndexType, StringValueType, Sub, Sum, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, Val, ValueTypes, VectorIndexConfig, type VectorIndexConfigOptions, VectorIndexType, type Where, type WhereDocument, WhereExpression, type WhereInput, type WhereJSON, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, getSparseEmbeddingFunction, knownEmbeddingFunctions, knownSparseEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, registerSparseEmbeddingFunction, serializeEmbeddingFunction, toSearch, withChroma };

package/dist/chromadb.legacy-esm.js

@@ -1515,7 +1515,8 @@ var pythonEmbeddingFunctions = {
   onnx_mini_lm_l6_v2: "default-embed",
   default: "default-embed",
   together_ai: "together-ai",
-  sentence_transformer: "sentence-transformer"
+  sentence_transformer: "sentence-transformer",
+  google_genai: "google-gemini"
 };
 var unsupportedEmbeddingFunctions = /* @__PURE__ */ new Set([
   "amazon_bedrock",
@@ -3276,9 +3277,19 @@ var Schema = class _Schema {
         "Cannot enable all index types globally. Must specify either config or key."
       );
     }
-    if (keyProvided && key && (key === EMBEDDING_KEY || key === DOCUMENT_KEY)) {
+    if (keyProvided && key && key === EMBEDDING_KEY) {
       throw new Error(
-        `Cannot create index on special key '${key}'. These keys are managed automatically by the system.`
+        `Cannot create index on special key '${key}'. This key is managed automatically by the system. Invoke createIndex(new VectorIndexConfig(...)) without specifying a key to configure the vector index globally.`
+      );
+    }
+    if (keyProvided && key === DOCUMENT_KEY && !(config instanceof FtsIndexConfig)) {
+      throw new Error(
+        `Cannot create index on special key '${key}' with this config. Only FtsIndexConfig is allowed for #document.`
+      );
+    }
+    if (keyProvided && key && key.startsWith("#") && key !== DOCUMENT_KEY) {
+      throw new Error(
+        "key cannot begin with '#'. Keys starting with '#' are reserved for system use."
       );
     }
     if (config instanceof VectorIndexConfig) {
@@ -3287,21 +3298,17 @@ var Schema = class _Schema {
         return this;
       }
       throw new Error(
-        "Vector index cannot be enabled on specific keys. Use createIndex(config=VectorIndexConfig(...)) without specifying a key to configure the vector index globally."
+        "Vector index cannot be enabled on specific keys. Use createIndex(new VectorIndexConfig(...)) without specifying a key to configure the vector index globally."
       );
     }
-    if (config instanceof FtsIndexConfig) {
-      if (!keyProvided) {
-        this.setFtsIndexConfig(config);
-        return this;
-      }
+    if (config instanceof FtsIndexConfig && (!keyProvided || key !== DOCUMENT_KEY)) {
       throw new Error(
-        "FTS index cannot be enabled on specific keys. Use createIndex(config=FtsIndexConfig(...)) without specifying a key to configure the FTS index globally."
+        "FTS index can only be enabled on #document key. Use createIndex(new FtsIndexConfig(), '#document')"
       );
     }
     if (config instanceof SparseVectorIndexConfig && !keyProvided) {
       throw new Error(
-        "Sparse vector index must be created on a specific key. Please specify a key using: createIndex(config=SparseVectorIndexConfig(...), key='your_key')"
+        "Sparse vector index must be created on a specific key. Please specify a key using: createIndex(new SparseVectorIndexConfig(...), 'your_key')"
       );
     }
     if (!configProvided && keyProvided && key) {
@@ -3324,22 +3331,32 @@ var Schema = class _Schema {
         "Cannot disable all indexes. Must specify either config or key."
       );
     }
-    if (keyProvided && key && (key === EMBEDDING_KEY || key === DOCUMENT_KEY)) {
+    if (keyProvided && key && key === EMBEDDING_KEY) {
+      throw new Error(
+        "Cannot modify #embedding. Currently not supported"
+      );
+    }
+    if (keyProvided && key === DOCUMENT_KEY && !(config instanceof FtsIndexConfig)) {
+      throw new Error(
+        `Cannot delete index on special key '${key}' with this config. Only FtsIndexConfig is allowed for #document.`
+      );
+    }
+    if (keyProvided && key && key.startsWith("#") && key !== DOCUMENT_KEY) {
       throw new Error(
-        `Cannot delete index on special key '${key}'. These keys are managed automatically by the system.`
+        "key cannot begin with '#'. Keys starting with '#' are reserved for system use."
       );
     }
     if (config instanceof VectorIndexConfig) {
       throw new Error("Deleting vector index is not currently supported.");
     }
-    if (config instanceof FtsIndexConfig) {
-      throw new Error("Deleting FTS index is not currently supported.");
-    }
     if (config instanceof SparseVectorIndexConfig) {
       throw new Error(
         "Deleting sparse vector index is not currently supported."
       );
     }
+    if (config instanceof FtsIndexConfig && (!keyProvided || key !== DOCUMENT_KEY)) {
+      throw new Error("Deleting FTS index is only supported on #document key.");
+    }
     if (keyProvided && !configProvided && key) {
       throw new Error(
         `Cannot disable all index types for key '${key}'. Please specify a specific index configuration.`
@@ -3423,22 +3440,6 @@ var Schema = class _Schema {
       })
     );
   }
-  setFtsIndexConfig(config) {
-    const defaultsString = ensureStringValueType(this.defaults);
-    const currentDefaultsFts = defaultsString.ftsIndex ?? new FtsIndexType(false, new FtsIndexConfig());
-    defaultsString.ftsIndex = new FtsIndexType(
-      currentDefaultsFts.enabled,
-      config
-    );
-    const documentValueTypes = ensureValueTypes(this.keys[DOCUMENT_KEY]);
-    this.keys[DOCUMENT_KEY] = documentValueTypes;
-    const overrideString = ensureStringValueType(documentValueTypes);
-    const currentOverrideFts = overrideString.ftsIndex ?? new FtsIndexType(true, new FtsIndexConfig());
-    overrideString.ftsIndex = new FtsIndexType(
-      currentOverrideFts.enabled,
-      config
-    );
-  }
   setIndexInDefaults(config, enabled) {
     if (config instanceof FtsIndexConfig) {
       const valueType = ensureStringValueType(this.defaults);
@@ -4263,15 +4264,24 @@ var CollectionImpl = class _CollectionImpl {
       embeddings
     };
   }
-  validateDelete(ids, where, whereDocument) {
+  validateDelete(ids, where, whereDocument, limit) {
     if (ids) validateIDs(ids);
     if (where) validateWhere(where);
     if (whereDocument) validateWhereDocument(whereDocument);
+    if (limit !== void 0 && (!Number.isInteger(limit) || limit < 0)) {
+      throw new Error("limit must be a non-negative integer");
+    }
+    if (limit !== void 0 && !where && !whereDocument) {
+      throw new Error(
+        "limit can only be specified when a where or whereDocument clause is provided"
+      );
+    }
   }
-  async count() {
+  async count(options) {
     const { data } = await RecordService.collectionCount({
       client: this.apiClient,
-      path: await this.path()
+      path: await this.path(),
+      query: options?.readLevel ? { read_level: options.readLevel } : void 0
     });
     return data;
   }
@@ -4523,18 +4533,21 @@ var CollectionImpl = class _CollectionImpl {
   async delete({
     ids,
     where,
-    whereDocument
+    whereDocument,
+    limit
   }) {
-    this.validateDelete(ids, where, whereDocument);
-    await RecordService.collectionDelete({
+    this.validateDelete(ids, where, whereDocument, limit);
+    const { data } = await RecordService.collectionDelete({
       client: this.apiClient,
       path: await this.path(),
       body: {
         ids,
         where,
-        where_document: whereDocument
+        where_document: whereDocument,
+        limit
       }
     });
+    return { deleted: data?.deleted ?? 0 };
   }
   async getIndexingStatus() {
     const { data } = await RecordService.indexingStatus({

package/dist/chromadb.mjs

@@ -1515,7 +1515,8 @@ var pythonEmbeddingFunctions = {
   onnx_mini_lm_l6_v2: "default-embed",
   default: "default-embed",
   together_ai: "together-ai",
-  sentence_transformer: "sentence-transformer"
+  sentence_transformer: "sentence-transformer",
+  google_genai: "google-gemini"
 };
 var unsupportedEmbeddingFunctions = /* @__PURE__ */ new Set([
   "amazon_bedrock",
@@ -3276,9 +3277,19 @@ var Schema = class _Schema {
         "Cannot enable all index types globally. Must specify either config or key."
       );
     }
-    if (keyProvided && key && (key === EMBEDDING_KEY || key === DOCUMENT_KEY)) {
+    if (keyProvided && key && key === EMBEDDING_KEY) {
       throw new Error(
-        `Cannot create index on special key '${key}'. These keys are managed automatically by the system.`
+        `Cannot create index on special key '${key}'. This key is managed automatically by the system. Invoke createIndex(new VectorIndexConfig(...)) without specifying a key to configure the vector index globally.`
+      );
+    }
+    if (keyProvided && key === DOCUMENT_KEY && !(config instanceof FtsIndexConfig)) {
+      throw new Error(
+        `Cannot create index on special key '${key}' with this config. Only FtsIndexConfig is allowed for #document.`
+      );
+    }
+    if (keyProvided && key && key.startsWith("#") && key !== DOCUMENT_KEY) {
+      throw new Error(
+        "key cannot begin with '#'. Keys starting with '#' are reserved for system use."
       );
     }
     if (config instanceof VectorIndexConfig) {
@@ -3287,21 +3298,17 @@ var Schema = class _Schema {
         return this;
       }
       throw new Error(
-        "Vector index cannot be enabled on specific keys. Use createIndex(config=VectorIndexConfig(...)) without specifying a key to configure the vector index globally."
+        "Vector index cannot be enabled on specific keys. Use createIndex(new VectorIndexConfig(...)) without specifying a key to configure the vector index globally."
       );
     }
-    if (config instanceof FtsIndexConfig) {
-      if (!keyProvided) {
-        this.setFtsIndexConfig(config);
-        return this;
-      }
+    if (config instanceof FtsIndexConfig && (!keyProvided || key !== DOCUMENT_KEY)) {
       throw new Error(
-        "FTS index cannot be enabled on specific keys. Use createIndex(config=FtsIndexConfig(...)) without specifying a key to configure the FTS index globally."
+        "FTS index can only be enabled on #document key. Use createIndex(new FtsIndexConfig(), '#document')"
       );
     }
     if (config instanceof SparseVectorIndexConfig && !keyProvided) {
       throw new Error(
-        "Sparse vector index must be created on a specific key. Please specify a key using: createIndex(config=SparseVectorIndexConfig(...), key='your_key')"
+        "Sparse vector index must be created on a specific key. Please specify a key using: createIndex(new SparseVectorIndexConfig(...), 'your_key')"
       );
     }
     if (!configProvided && keyProvided && key) {
@@ -3324,22 +3331,32 @@ var Schema = class _Schema {
         "Cannot disable all indexes. Must specify either config or key."
       );
     }
-    if (keyProvided && key && (key === EMBEDDING_KEY || key === DOCUMENT_KEY)) {
+    if (keyProvided && key && key === EMBEDDING_KEY) {
+      throw new Error(
+        "Cannot modify #embedding. Currently not supported"
+      );
+    }
+    if (keyProvided && key === DOCUMENT_KEY && !(config instanceof FtsIndexConfig)) {
+      throw new Error(
+        `Cannot delete index on special key '${key}' with this config. Only FtsIndexConfig is allowed for #document.`
+      );
+    }
+    if (keyProvided && key && key.startsWith("#") && key !== DOCUMENT_KEY) {
       throw new Error(
-        `Cannot delete index on special key '${key}'. These keys are managed automatically by the system.`
+        "key cannot begin with '#'. Keys starting with '#' are reserved for system use."
       );
     }
     if (config instanceof VectorIndexConfig) {
       throw new Error("Deleting vector index is not currently supported.");
     }
-    if (config instanceof FtsIndexConfig) {
-      throw new Error("Deleting FTS index is not currently supported.");
-    }
     if (config instanceof SparseVectorIndexConfig) {
       throw new Error(
         "Deleting sparse vector index is not currently supported."
       );
     }
+    if (config instanceof FtsIndexConfig && (!keyProvided || key !== DOCUMENT_KEY)) {
+      throw new Error("Deleting FTS index is only supported on #document key.");
+    }
     if (keyProvided && !configProvided && key) {
       throw new Error(
         `Cannot disable all index types for key '${key}'. Please specify a specific index configuration.`
@@ -3423,22 +3440,6 @@ var Schema = class _Schema {
       })
     );
   }
-  setFtsIndexConfig(config) {
-    const defaultsString = ensureStringValueType(this.defaults);
-    const currentDefaultsFts = defaultsString.ftsIndex ?? new FtsIndexType(false, new FtsIndexConfig());
-    defaultsString.ftsIndex = new FtsIndexType(
-      currentDefaultsFts.enabled,
-      config
-    );
-    const documentValueTypes = ensureValueTypes(this.keys[DOCUMENT_KEY]);
-    this.keys[DOCUMENT_KEY] = documentValueTypes;
-    const overrideString = ensureStringValueType(documentValueTypes);
-    const currentOverrideFts = overrideString.ftsIndex ?? new FtsIndexType(true, new FtsIndexConfig());
-    overrideString.ftsIndex = new FtsIndexType(
-      currentOverrideFts.enabled,
-      config
-    );
-  }
   setIndexInDefaults(config, enabled) {
     if (config instanceof FtsIndexConfig) {
       const valueType = ensureStringValueType(this.defaults);
@@ -4263,15 +4264,24 @@ var CollectionImpl = class _CollectionImpl {
       embeddings
     };
   }
-  validateDelete(ids, where, whereDocument) {
+  validateDelete(ids, where, whereDocument, limit) {
     if (ids) validateIDs(ids);
     if (where) validateWhere(where);
     if (whereDocument) validateWhereDocument(whereDocument);
+    if (limit !== void 0 && (!Number.isInteger(limit) || limit < 0)) {
+      throw new Error("limit must be a non-negative integer");
+    }
+    if (limit !== void 0 && !where && !whereDocument) {
+      throw new Error(
+        "limit can only be specified when a where or whereDocument clause is provided"
+      );
+    }
   }
-  async count() {
+  async count(options) {
     const { data } = await RecordService.collectionCount({
       client: this.apiClient,
-      path: await this.path()
+      path: await this.path(),
+      query: options?.readLevel ? { read_level: options.readLevel } : void 0
     });
     return data;
   }
@@ -4523,18 +4533,21 @@ var CollectionImpl = class _CollectionImpl {
   async delete({
     ids,
     where,
-    whereDocument
+    whereDocument,
+    limit
   }) {
-    this.validateDelete(ids, where, whereDocument);
-    await RecordService.collectionDelete({
+    this.validateDelete(ids, where, whereDocument, limit);
+    const { data } = await RecordService.collectionDelete({
       client: this.apiClient,
       path: await this.path(),
       body: {
         ids,
         where,
-        where_document: whereDocument
+        where_document: whereDocument,
+        limit
       }
     });
+    return { deleted: data?.deleted ?? 0 };
   }
   async getIndexingStatus() {
     const { data } = await RecordService.indexingStatus({