chromadb 3.1.0 → 3.1.2

package/dist/chromadb.d.ts

@@ -688,14 +688,14 @@ declare const registerSparseEmbeddingFunction: (name: string, fn: SparseEmbeddin
  * @param efConfig - Configuration for the embedding function
  * @returns EmbeddingFunction instance or undefined if it cannot be constructed
  */
-declare const getEmbeddingFunction: (collectionName: string, efConfig?: EmbeddingFunctionConfiguration) => EmbeddingFunction | undefined;
+declare const getEmbeddingFunction: (collectionName: string, 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) => SparseEmbeddingFunction | undefined;
+declare const getSparseEmbeddingFunction: (collectionName: string, efConfig?: EmbeddingFunctionConfiguration) => Promise<SparseEmbeddingFunction | undefined>;
 /**
  * Serializes an embedding function to configuration format.
  * @param embeddingFunction - User provided embedding function
@@ -714,55 +714,170 @@ declare const serializeEmbeddingFunction: ({ embeddingFunction, configEmbeddingF
  */
 declare const getDefaultEFConfig: () => Promise<EmbeddingFunctionConfiguration>;
 
-interface CollectionConfiguration {
-    embeddingFunction?: EmbeddingFunctionConfiguration | null;
-    hnsw?: HNSWConfiguration | null;
-    spann?: SpannConfiguration | null;
+type WhereJSON = Record<string, unknown>;
+type WhereInput = WhereExpression | WhereJSON | null | undefined;
+declare abstract class WhereExpressionBase {
+    abstract toJSON(): WhereJSON;
+    and(other: WhereInput): WhereExpression;
+    or(other: WhereInput): WhereExpression;
 }
-type HNSWConfiguration = HnswConfiguration & {
-    batch_size?: number | null;
-    num_threads?: number | null;
-};
-type CreateCollectionConfiguration = Omit<CollectionConfiguration, "embeddingFunction"> & {
-    embeddingFunction?: EmbeddingFunction;
-};
-interface UpdateCollectionConfiguration {
-    embeddingFunction?: EmbeddingFunction;
-    hnsw?: UpdateHNSWConfiguration;
-    spann?: UpdateSPANNConfiguration;
+declare abstract class WhereExpression extends WhereExpressionBase {
+    static from(input: WhereInput): WhereExpression | undefined;
 }
-interface UpdateHNSWConfiguration {
-    batch_size?: number;
-    ef_search?: number;
-    num_threads?: number;
-    resize_factor?: number;
-    sync_threshold?: number;
+
+type IterableInput<T> = Iterable<T> | ArrayLike<T>;
+
+declare class Key {
+    readonly name: string;
+    static readonly ID: Key;
+    static readonly DOCUMENT: Key;
+    static readonly EMBEDDING: Key;
+    static readonly METADATA: Key;
+    static readonly SCORE: Key;
+    constructor(name: string);
+    eq(value: unknown): WhereExpression;
+    ne(value: unknown): WhereExpression;
+    gt(value: unknown): WhereExpression;
+    gte(value: unknown): WhereExpression;
+    lt(value: unknown): WhereExpression;
+    lte(value: unknown): WhereExpression;
+    isIn(values: IterableInput<unknown>): WhereExpression;
+    notIn(values: IterableInput<unknown>): WhereExpression;
+    contains(value: string): WhereExpression;
+    notContains(value: string): WhereExpression;
+    regex(pattern: string): WhereExpression;
+    notRegex(pattern: string): WhereExpression;
 }
-interface UpdateSPANNConfiguration {
-    search_nprobe?: number;
-    ef_search?: number;
+interface KeyFactory {
+    (name: string): Key;
+    ID: Key;
+    DOCUMENT: Key;
+    EMBEDDING: Key;
+    METADATA: Key;
+    SCORE: Key;
+}
+declare const K: KeyFactory;
+
+interface LimitOptions {
+    offset?: number;
+    limit?: number | null | undefined;
+}
+type LimitInput = Limit | number | LimitOptions | null | undefined;
+declare class Limit {
+    readonly offset: number;
+    readonly limit?: number;
+    constructor(options?: LimitOptions);
+    static from(input: LimitInput, offsetOverride?: number): Limit;
+    toJSON(): {
+        offset: number;
+        limit?: number;
+    };
+}
+
+type SelectKeyInput = string | Key;
+type SelectInput = Select | Iterable<SelectKeyInput> | {
+    keys?: Iterable<SelectKeyInput>;
+} | null | undefined;
+declare class Select {
+    private readonly keys;
+    constructor(keys?: Iterable<SelectKeyInput>);
+    static from(input: SelectInput): Select;
+    static all(): Select;
+    get values(): string[];
+    toJSON(): {
+        keys: string[];
+    };
+}
+
+type RankLiteral = Record<string, unknown>;
+type RankInput = RankExpression | RankLiteral | number | null | undefined;
+declare abstract class RankExpressionBase {
+    abstract toJSON(): Record<string, unknown>;
+    add(...others: RankInput[]): RankExpression;
+    subtract(other: RankInput): RankExpression;
+    multiply(...others: RankInput[]): RankExpression;
+    divide(other: RankInput): RankExpression;
+    negate(): RankExpression;
+    abs(): RankExpression;
+    exp(): RankExpression;
+    log(): RankExpression;
+    max(...others: RankInput[]): RankExpression;
+    min(...others: RankInput[]): RankExpression;
+}
+declare abstract class RankExpression extends RankExpressionBase {
+    static from(input: RankInput): RankExpression | undefined;
+}
+interface KnnOptions {
+    query: IterableInput<number> | SparseVector | string;
+    key?: string | Key;
+    limit?: number;
+    default?: number | null;
+    returnRank?: boolean;
+}
+declare const Val: (value: number) => RankExpression;
+declare const Knn: (options: KnnOptions) => RankExpression;
+interface RrfOptions {
+    ranks: RankInput[];
+    k?: number;
+    weights?: number[];
+    normalize?: boolean;
+}
+declare const Rrf: ({ ranks, k, weights, normalize }: RrfOptions) => RankExpression;
+declare const Sum: (...inputs: RankInput[]) => RankExpression;
+declare const Sub: (left: RankInput, right: RankInput) => RankExpression;
+declare const Mul: (...inputs: RankInput[]) => RankExpression;
+declare const Div: (left: RankInput, right: RankInput) => RankExpression;
+declare const Abs: (input: RankInput) => RankExpression;
+declare const Exp: (input: RankInput) => RankExpression;
+declare const Log: (input: RankInput) => RankExpression;
+declare const Max: (...inputs: RankInput[]) => RankExpression;
+declare const Min: (...inputs: RankInput[]) => RankExpression;
+
+interface SearchInit {
+    where?: WhereInput;
+    rank?: RankInput;
+    limit?: LimitInput;
+    select?: SelectInput;
+}
+declare class Search {
+    private _where?;
+    private _rank?;
+    private _limit;
+    private _select;
+    constructor(init?: SearchInit);
+    private clone;
+    where(where?: WhereInput): Search;
+    rank(rank?: RankInput): Search;
+    limit(limit?: LimitInput, offset?: number): Search;
+    select(keys?: SelectInput): Search;
+    select(...keys: SelectKeyInput[]): Search;
+    selectAll(): Search;
+    get whereClause(): WhereExpression | undefined;
+    get rankExpression(): RankExpression | undefined;
+    get limitConfig(): Limit;
+    get selectConfig(): Select;
+    toPayload(): SearchPayload;
+}
+type SearchLike = Search | SearchInit;
+declare const toSearch: (input: SearchLike) => Search;
+
+interface SearchResultRow {
+    id: string;
+    document?: string | null;
+    embedding?: number[] | null;
+    metadata?: Metadata | null;
+    score?: number | null;
+}
+declare class SearchResult {
+    readonly ids: string[][];
+    readonly documents: Array<Array<string | null> | null>;
+    readonly embeddings: Array<Array<Array<number> | null> | null>;
+    readonly metadatas: Array<Array<Metadata | null> | null>;
+    readonly scores: Array<Array<number | null> | null>;
+    readonly select: SearchResponse["select"];
+    constructor(response: SearchResponse);
+    rows(): SearchResultRow[][];
 }
-/**
- * Validate user provided collection configuration and embedding function. Returns a
- * CollectionConfiguration to be used in collection creation.
- */
-declare const processCreateCollectionConfig: ({ configuration, embeddingFunction, metadata, }: {
-    configuration?: CreateCollectionConfiguration;
-    embeddingFunction?: EmbeddingFunction | null;
-    metadata?: CollectionMetadata;
-}) => Promise<CollectionConfiguration>;
-/**
- *
- */
-declare const processUpdateCollectionConfig: ({ collectionName, currentConfiguration, currentEmbeddingFunction, newConfiguration, }: {
-    collectionName: string;
-    currentConfiguration: CollectionConfiguration;
-    currentEmbeddingFunction?: EmbeddingFunction;
-    newConfiguration: UpdateCollectionConfiguration;
-}) => Promise<{
-    updateConfiguration?: UpdateCollectionConfiguration$1;
-    updateEmbeddingFunction?: EmbeddingFunction;
-}>;
 
 declare const DOCUMENT_KEY = "#document";
 declare const EMBEDDING_KEY = "#embedding";
@@ -784,14 +899,14 @@ declare class BoolInvertedIndexConfig {
 interface VectorIndexConfigOptions {
     space?: Space | null;
     embeddingFunction?: EmbeddingFunction | null;
-    sourceKey?: string | null;
+    sourceKey?: string | Key | null;
     hnsw?: HnswIndexConfig | null;
     spann?: SpannIndexConfig | null;
 }
 declare class VectorIndexConfig {
     readonly type = "VectorIndexConfig";
     space: Space | null;
-    embeddingFunction: EmbeddingFunction | null;
+    embeddingFunction?: EmbeddingFunction | null;
     sourceKey: string | null;
     hnsw: HnswIndexConfig | null;
     spann: SpannIndexConfig | null;
@@ -799,12 +914,12 @@ declare class VectorIndexConfig {
 }
 interface SparseVectorIndexConfigOptions {
     embeddingFunction?: SparseEmbeddingFunction | null;
-    sourceKey?: string | null;
+    sourceKey?: string | Key | null;
     bm25?: boolean | null;
 }
 declare class SparseVectorIndexConfig {
     readonly type = "SparseVectorIndexConfig";
-    embeddingFunction: SparseEmbeddingFunction | null;
+    embeddingFunction?: SparseEmbeddingFunction | null;
     sourceKey: string | null;
     bm25: boolean | null;
     constructor(options?: SparseVectorIndexConfigOptions);
@@ -886,7 +1001,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): Schema | undefined;
+    static deserializeFromJSON(json?: Schema$1 | JsonDict | null): Promise<Schema | undefined>;
     private setVectorIndexConfig;
     private setFtsIndexConfig;
     private setIndexInDefaults;
@@ -915,8 +1030,60 @@ declare class Schema {
     private static deserializeBoolValueType;
     private static deserializeVectorConfig;
     private static deserializeSparseVectorConfig;
+    resolveEmbeddingFunction(): EmbeddingFunction | null | undefined;
 }
 
+interface CollectionConfiguration {
+    embeddingFunction?: EmbeddingFunctionConfiguration | null;
+    hnsw?: HNSWConfiguration | null;
+    spann?: SpannConfiguration | null;
+}
+type HNSWConfiguration = HnswConfiguration & {
+    batch_size?: number | null;
+    num_threads?: number | null;
+};
+type CreateCollectionConfiguration = Omit<CollectionConfiguration, "embeddingFunction"> & {
+    embeddingFunction?: EmbeddingFunction;
+};
+interface UpdateCollectionConfiguration {
+    embeddingFunction?: EmbeddingFunction;
+    hnsw?: UpdateHNSWConfiguration;
+    spann?: UpdateSPANNConfiguration;
+}
+interface UpdateHNSWConfiguration {
+    batch_size?: number;
+    ef_search?: number;
+    num_threads?: number;
+    resize_factor?: number;
+    sync_threshold?: number;
+}
+interface UpdateSPANNConfiguration {
+    search_nprobe?: number;
+    ef_search?: number;
+}
+/**
+ * Validate user provided collection configuration and embedding function. Returns a
+ * CollectionConfiguration to be used in collection creation.
+ */
+declare const processCreateCollectionConfig: ({ configuration, embeddingFunction, metadata, schema, }: {
+    configuration?: CreateCollectionConfiguration;
+    embeddingFunction?: EmbeddingFunction | null;
+    metadata?: CollectionMetadata;
+    schema?: Schema;
+}) => Promise<CollectionConfiguration>;
+/**
+ *
+ */
+declare const processUpdateCollectionConfig: ({ collectionName, currentConfiguration, currentEmbeddingFunction, newConfiguration, }: {
+    collectionName: string;
+    currentConfiguration: CollectionConfiguration;
+    currentEmbeddingFunction?: EmbeddingFunction;
+    newConfiguration: UpdateCollectionConfiguration;
+}) => Promise<{
+    updateConfiguration?: UpdateCollectionConfiguration$1;
+    updateEmbeddingFunction?: EmbeddingFunction;
+}>;
+
 /**
  * Configuration options for the ChromaClient.
  */
@@ -1093,171 +1260,6 @@ declare class ChromaClient {
     supportsBase64Encoding(): Promise<boolean>;
 }
 
-type WhereJSON = Record<string, unknown>;
-type WhereInput = WhereExpression | WhereJSON | null | undefined;
-declare abstract class WhereExpressionBase {
-    abstract toJSON(): WhereJSON;
-    and(other: WhereInput): WhereExpression;
-    or(other: WhereInput): WhereExpression;
-}
-declare abstract class WhereExpression extends WhereExpressionBase {
-    static from(input: WhereInput): WhereExpression | undefined;
-}
-
-type IterableInput<T> = Iterable<T> | ArrayLike<T>;
-
-declare class Key {
-    readonly name: string;
-    static readonly ID: Key;
-    static readonly DOCUMENT: Key;
-    static readonly EMBEDDING: Key;
-    static readonly METADATA: Key;
-    static readonly SCORE: Key;
-    constructor(name: string);
-    eq(value: unknown): WhereExpression;
-    ne(value: unknown): WhereExpression;
-    gt(value: unknown): WhereExpression;
-    gte(value: unknown): WhereExpression;
-    lt(value: unknown): WhereExpression;
-    lte(value: unknown): WhereExpression;
-    isIn(values: IterableInput<unknown>): WhereExpression;
-    notIn(values: IterableInput<unknown>): WhereExpression;
-    contains(value: string): WhereExpression;
-    notContains(value: string): WhereExpression;
-    regex(pattern: string): WhereExpression;
-    notRegex(pattern: string): WhereExpression;
-}
-interface KeyFactory {
-    (name: string): Key;
-    ID: Key;
-    DOCUMENT: Key;
-    EMBEDDING: Key;
-    METADATA: Key;
-    SCORE: Key;
-}
-declare const K: KeyFactory;
-
-interface LimitOptions {
-    offset?: number;
-    limit?: number | null | undefined;
-}
-type LimitInput = Limit | number | LimitOptions | null | undefined;
-declare class Limit {
-    readonly offset: number;
-    readonly limit?: number;
-    constructor(options?: LimitOptions);
-    static from(input: LimitInput, offsetOverride?: number): Limit;
-    toJSON(): {
-        offset: number;
-        limit?: number;
-    };
-}
-
-type SelectKeyInput = string | Key;
-type SelectInput = Select | Iterable<SelectKeyInput> | {
-    keys?: Iterable<SelectKeyInput>;
-} | null | undefined;
-declare class Select {
-    private readonly keys;
-    constructor(keys?: Iterable<SelectKeyInput>);
-    static from(input: SelectInput): Select;
-    static all(): Select;
-    get values(): string[];
-    toJSON(): {
-        keys: string[];
-    };
-}
-
-type RankLiteral = Record<string, unknown>;
-type RankInput = RankExpression | RankLiteral | number | null | undefined;
-declare abstract class RankExpressionBase {
-    abstract toJSON(): Record<string, unknown>;
-    add(...others: RankInput[]): RankExpression;
-    subtract(other: RankInput): RankExpression;
-    multiply(...others: RankInput[]): RankExpression;
-    divide(other: RankInput): RankExpression;
-    negate(): RankExpression;
-    abs(): RankExpression;
-    exp(): RankExpression;
-    log(): RankExpression;
-    max(...others: RankInput[]): RankExpression;
-    min(...others: RankInput[]): RankExpression;
-}
-declare abstract class RankExpression extends RankExpressionBase {
-    static from(input: RankInput): RankExpression | undefined;
-}
-interface KnnOptions {
-    query: IterableInput<number> | SparseVector | string;
-    key?: string | Key;
-    limit?: number;
-    default?: number | null;
-    returnRank?: boolean;
-}
-declare const Val: (value: number) => RankExpression;
-declare const Knn: (options: KnnOptions) => RankExpression;
-interface RrfOptions {
-    ranks: RankInput[];
-    k?: number;
-    weights?: number[];
-    normalize?: boolean;
-}
-declare const Rrf: ({ ranks, k, weights, normalize }: RrfOptions) => RankExpression;
-declare const Sum: (...inputs: RankInput[]) => RankExpression;
-declare const Sub: (left: RankInput, right: RankInput) => RankExpression;
-declare const Mul: (...inputs: RankInput[]) => RankExpression;
-declare const Div: (left: RankInput, right: RankInput) => RankExpression;
-declare const Abs: (input: RankInput) => RankExpression;
-declare const Exp: (input: RankInput) => RankExpression;
-declare const Log: (input: RankInput) => RankExpression;
-declare const Max: (...inputs: RankInput[]) => RankExpression;
-declare const Min: (...inputs: RankInput[]) => RankExpression;
-
-interface SearchInit {
-    where?: WhereInput;
-    rank?: RankInput;
-    limit?: LimitInput;
-    select?: SelectInput;
-}
-declare class Search {
-    private _where?;
-    private _rank?;
-    private _limit;
-    private _select;
-    constructor(init?: SearchInit);
-    private clone;
-    where(where?: WhereInput): Search;
-    rank(rank?: RankInput): Search;
-    limit(limit?: LimitInput, offset?: number): Search;
-    select(keys?: SelectInput): Search;
-    select(...keys: SelectKeyInput[]): Search;
-    selectAll(): Search;
-    get whereClause(): WhereExpression | undefined;
-    get rankExpression(): RankExpression | undefined;
-    get limitConfig(): Limit;
-    get selectConfig(): Select;
-    toPayload(): SearchPayload;
-}
-type SearchLike = Search | SearchInit;
-declare const toSearch: (input: SearchLike) => Search;
-
-interface SearchResultRow {
-    id: string;
-    document?: string | null;
-    embedding?: number[] | null;
-    metadata?: Metadata | null;
-    score?: number | null;
-}
-declare class SearchResult {
-    readonly ids: string[][];
-    readonly documents: Array<Array<string | null> | null>;
-    readonly embeddings: Array<Array<Array<number> | null> | null>;
-    readonly metadatas: Array<Array<Metadata | null> | null>;
-    readonly scores: Array<Array<number | null> | null>;
-    readonly select: SearchResponse["select"];
-    constructor(response: SearchResponse);
-    rows(): SearchResultRow[][];
-}
-
 /**
  * Interface for collection operations using collection ID.
  * Provides methods for adding, querying, updating, and deleting records.