chromadb 3.2.2 → 3.3.0

package/dist/chromadb.d.ts

@@ -63,7 +63,7 @@ type GetUserIdentityResponse = {
     user_id: string;
 };
 type HashMap = {
-    [key: string]: boolean | number | string | SparseVector | null;
+    [key: string]: boolean | number | string | SparseVector | Array<boolean> | Array<number> | Array<string> | null;
 };
 type HnswConfiguration = {
     ef_construction?: number | null;
@@ -85,6 +85,9 @@ type HnswIndexConfig = {
     resize_factor?: number | null;
     sync_threshold?: number | null;
 };
+/**
+ * Use this enum to specify which fields should be returned when retrieving records.
+ */
 type Include = 'distances' | 'documents' | 'embeddings' | 'metadatas' | 'uris';
 type IndexStatusResponse = {
     num_indexed_ops: number;
@@ -250,6 +253,7 @@ type SpannConfiguration = {
  * Configuration for SPANN vector index algorithm parameters
  */
 type SpannIndexConfig = {
+    center_drift_threshold?: number | null;
     ef_construction?: number | null;
     ef_search?: number | null;
     initial_lambda?: number | null;
@@ -258,6 +262,10 @@ type SpannIndexConfig = {
     nreplica_count?: number | null;
     num_centers_to_merge_to?: number | null;
     num_samples_kmeans?: number | null;
+    /**
+     * Enable quantization for vector search (cloud-only feature)
+     */
+    quantize?: boolean;
     reassign_neighbor_count?: number | null;
     search_nprobe?: number | null;
     search_rng_epsilon?: number | null;
@@ -386,16 +394,20 @@ declare const ReadLevel: {
 };
 type ReadLevel = (typeof ReadLevel)[keyof typeof ReadLevel];
 
+/**
+ * Scalar metadata values that can be stored in arrays.
+ */
+type MetadataScalar = boolean | number | string;
 /**
  * Metadata that can be associated with a collection.
- * Values must be boolean, number, or string types.
+ * Values can be boolean, number, string, SparseVector, typed arrays, or null.
  */
-type CollectionMetadata = Record<string, boolean | number | string | SparseVector | null>;
+type CollectionMetadata = Record<string, boolean | number | string | SparseVector | boolean[] | number[] | string[] | null>;
 /**
  * Metadata that can be associated with individual records.
- * Values must be boolean, number, or string types.
+ * Values can be boolean, number, string, SparseVector, typed arrays, or null.
  */
-type Metadata = Record<string, boolean | number | string | SparseVector | null>;
+type Metadata = Record<string, boolean | number | string | SparseVector | boolean[] | number[] | string[] | null>;
 /**
  * Base interface for record sets containing optional fields.
  */
@@ -454,6 +466,10 @@ type OperatorExpression = {
     $in: LiteralValue[];
 } | {
     $nin: LiteralValue[];
+} | {
+    $contains: LiteralValue;
+} | {
+    $not_contains: LiteralValue;
 };
 /**
  * Where clause for filtering records based on metadata.
@@ -786,8 +802,29 @@ declare class Key {
     lte(value: unknown): WhereExpression;
     isIn(values: IterableInput<unknown>): WhereExpression;
     notIn(values: IterableInput<unknown>): WhereExpression;
-    contains(value: string): WhereExpression;
-    notContains(value: string): WhereExpression;
+    /**
+     * Contains filter.
+     *
+     * On `Key.DOCUMENT`: substring search (value must be a string).
+     * On metadata fields: checks if the array field contains the scalar value.
+     *
+     * @example
+     * K.DOCUMENT.contains("machine learning")   // document substring
+     * K("tags").contains("action")               // metadata array contains
+     * K("scores").contains(42)                   // metadata array contains
+     */
+    contains(value: string | number | boolean): WhereExpression;
+    /**
+     * Not-contains filter.
+     *
+     * On `Key.DOCUMENT`: excludes documents containing the substring.
+     * On metadata fields: checks that the array field does not contain the scalar value.
+     *
+     * @example
+     * K.DOCUMENT.notContains("deprecated")   // document substring exclusion
+     * K("tags").notContains("draft")          // metadata array not-contains
+     */
+    notContains(value: string | number | boolean): WhereExpression;
     regex(pattern: string): WhereExpression;
     notRegex(pattern: string): WhereExpression;
 }
@@ -1897,4 +1934,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, 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, 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 };