chromadb 2.3.0 → 2.4.2

package/dist/chromadb.d.ts

@@ -301,35 +301,35 @@ declare namespace Api {
     }
     interface HnswConfiguration {
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof HnswConfiguration
          * minimum: 0
          */
-        ef_construction?: number;
+        ef_construction?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof HnswConfiguration
          * minimum: 0
          */
-        ef_search?: number;
+        ef_search?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof HnswConfiguration
          * minimum: 0
          */
-        max_neighbors?: number;
+        max_neighbors?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof HnswConfiguration
          */
-        resize_factor?: number;
+        resize_factor?: number | null;
         space?: Api.HnswSpace;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof HnswConfiguration
          * minimum: 0
          */
-        sync_threshold?: number;
+        sync_threshold?: number | null;
     }
     enum HnswSpace {
         L2 = "l2",
@@ -371,54 +371,54 @@ declare namespace Api {
     }
     interface SpannConfiguration {
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        ef_construction?: number;
+        ef_construction?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        ef_search?: number;
+        ef_search?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        max_neighbors?: number;
+        max_neighbors?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        merge_threshold?: number;
+        merge_threshold?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        reassign_neighbor_count?: number;
+        reassign_neighbor_count?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        search_nprobe?: number;
+        search_nprobe?: number | null;
         space?: Api.HnswSpace;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        split_threshold?: number;
+        split_threshold?: number | null;
         /**
-         * @type {number}
+         * @type {number | null}
          * @memberof SpannConfiguration
          * minimum: 0
          */
-        write_nprobe?: number;
+        write_nprobe?: number | null;
     }
     interface UpdateCollectionConfiguration {
         embedding_function?: Api.EmbeddingFunctionConfiguration | null;
@@ -968,6 +968,7 @@ type ForkCollectionParams = {
     newName: string;
 };
 type BaseQueryParams = {
+    ids?: ID | IDs;
     nResults?: PositiveInteger;
     where?: Where;
     queryTexts?: string | string[];
@@ -1122,6 +1123,7 @@ declare class Collection {
      * @param {string | string[]} [params.queryTexts] - Optional query text(s) to search for in the collection.
      * @param {WhereDocument} [params.whereDocument] - Optional query condition to filter results based on document content.
      * @param {IncludeEnum[]} [params.include] - Optional array of fields to include in the result, such as "metadata" and "document".
+     * @param {IDs} [params.ids] - Optional IDs to filter on before querying.
      *
      * @returns {Promise<QueryResponse>} A promise that resolves to the query results.
      * @throws {Error} If there is an issue executing the query.
@@ -1145,7 +1147,7 @@ declare class Collection {
      * ```
      *
      */
-    query({ nResults, where, whereDocument, include, queryTexts, queryEmbeddings, }: QueryRecordsParams): Promise<MultiQueryResponse>;
+    query({ nResults, where, whereDocument, include, queryTexts, queryEmbeddings, ids, }: QueryRecordsParams): Promise<MultiQueryResponse>;
     /**
      * Modify the collection name or metadata
      * @param {Object} params - The parameters for the query.
@@ -1633,7 +1635,7 @@ declare class CloudClient extends ChromaClient {
     constructor({ apiKey, database, tenant, cloudHost, cloudPort, }: CloudClientParams);
 }
 
-interface StoredConfig$8 {
+interface StoredConfig$a {
     model_name: string;
     api_key_env_var: string;
 }
@@ -1661,15 +1663,15 @@ declare class CohereEmbeddingFunction implements IEmbeddingFunction {
     });
     private initCohereClient;
     generate(texts: string[]): Promise<number[][]>;
-    buildFromConfig(config: StoredConfig$8): CohereEmbeddingFunction;
-    getConfig(): StoredConfig$8;
-    validateConfigUpdate(oldConfig: StoredConfig$8, newConfig: StoredConfig$8): void;
-    validateConfig(config: StoredConfig$8): void;
+    buildFromConfig(config: StoredConfig$a): CohereEmbeddingFunction;
+    getConfig(): StoredConfig$a;
+    validateConfigUpdate(oldConfig: StoredConfig$a, newConfig: StoredConfig$a): void;
+    validateConfig(config: StoredConfig$a): void;
     supportedSpaces(): EmbeddingFunctionSpace[];
     defaultSpace(): EmbeddingFunctionSpace;
 }
 
-interface StoredConfig$7 {
+interface StoredConfig$9 {
     model_name: string;
     revision: string;
     quantized: boolean;
@@ -1697,10 +1699,10 @@ declare class DefaultEmbeddingFunction implements IEmbeddingFunction {
         progress_callback?: Function | null;
     });
     generate(texts: string[]): Promise<number[][]>;
-    getConfig(): StoredConfig$7;
-    buildFromConfig(config: StoredConfig$7): DefaultEmbeddingFunction;
-    validateConfigUpdate(oldConfig: StoredConfig$7, newConfig: StoredConfig$7): void;
-    validateConfig(config: StoredConfig$7): void;
+    getConfig(): StoredConfig$9;
+    buildFromConfig(config: StoredConfig$9): DefaultEmbeddingFunction;
+    validateConfigUpdate(oldConfig: StoredConfig$9, newConfig: StoredConfig$9): void;
+    validateConfig(config: StoredConfig$9): void;
     private loadClient;
     /** @ignore */
     static import(): Promise<{
@@ -1708,7 +1710,7 @@ declare class DefaultEmbeddingFunction implements IEmbeddingFunction {
     }>;
 }
 
-interface StoredConfig$6 {
+interface StoredConfig$8 {
     api_key_env_var: string;
     model_name: string;
     task_type: string;
@@ -1732,29 +1734,34 @@ declare class GoogleGenerativeAiEmbeddingFunction implements IEmbeddingFunction
     static import(): Promise<{
         googleGenAi: typeof _google_generative_ai;
     }>;
-    buildFromConfig(config: StoredConfig$6): GoogleGenerativeAiEmbeddingFunction;
-    getConfig(): StoredConfig$6;
+    buildFromConfig(config: StoredConfig$8): GoogleGenerativeAiEmbeddingFunction;
+    getConfig(): StoredConfig$8;
     validateConfigUpdate(oldConfig: Record<string, any>, newConfig: Record<string, any>): void;
     validateConfig(config: Record<string, any>): void;
 }
 
-type StoredConfig$5 = {
+type StoredConfig$7 = {
     url: string;
+    api_key_env_var?: string;
 };
 declare class HuggingFaceEmbeddingServerFunction implements IEmbeddingFunction {
     name: string;
     private url;
-    constructor({ url }: {
+    private api_key_env_var?;
+    private headers?;
+    constructor({ api_key, url, api_key_env_var, }: {
         url: string;
+        api_key?: string;
+        api_key_env_var?: string;
     });
     generate(texts: string[]): Promise<any>;
-    buildFromConfig(config: StoredConfig$5): HuggingFaceEmbeddingServerFunction;
-    getConfig(): StoredConfig$5;
+    buildFromConfig(config: StoredConfig$7): HuggingFaceEmbeddingServerFunction;
+    getConfig(): StoredConfig$7;
     validateConfigUpdate(oldConfig: Record<string, any>, newConfig: Record<string, any>): void;
     validateConfig(config: Record<string, any>): void;
 }
 
-type StoredConfig$4 = {
+type StoredConfig$6 = {
     api_key_env_var: string;
     model_name: string;
     task?: string;
@@ -1788,12 +1795,12 @@ declare class JinaEmbeddingFunction implements IEmbeddingFunction {
         normalized?: boolean;
     });
     generate(texts: string[]): Promise<any[]>;
-    buildFromConfig(config: StoredConfig$4): JinaEmbeddingFunction;
-    getConfig(): StoredConfig$4;
-    validateConfig(config: StoredConfig$4): void;
+    buildFromConfig(config: StoredConfig$6): JinaEmbeddingFunction;
+    getConfig(): StoredConfig$6;
+    validateConfig(config: StoredConfig$6): void;
 }
 
-type StoredConfig$3 = {
+type StoredConfig$5 = {
     url: string;
     model_name: string;
 };
@@ -1812,12 +1819,12 @@ declare class OllamaEmbeddingFunction implements IEmbeddingFunction {
         ollama: typeof ollama;
     }>;
     generate(texts: string[]): Promise<any>;
-    buildFromConfig(config: StoredConfig$3): OllamaEmbeddingFunction;
-    getConfig(): StoredConfig$3;
-    validateConfig(config: StoredConfig$3): void;
+    buildFromConfig(config: StoredConfig$5): OllamaEmbeddingFunction;
+    getConfig(): StoredConfig$5;
+    validateConfig(config: StoredConfig$5): void;
 }
 
-type StoredConfig$2 = {
+type StoredConfig$4 = {
     api_key_env_var: string;
     model_name: string;
     organization_id: string;
@@ -1844,13 +1851,13 @@ declare class OpenAIEmbeddingFunction implements IEmbeddingFunction {
         openai: typeof openai;
         version: string;
     }>;
-    buildFromConfig(config: StoredConfig$2): OpenAIEmbeddingFunction;
-    getConfig(): StoredConfig$2;
-    validateConfigUpdate(oldConfig: StoredConfig$2, newConfig: StoredConfig$2): void;
-    validateConfig(config: StoredConfig$2): void;
+    buildFromConfig(config: StoredConfig$4): OpenAIEmbeddingFunction;
+    getConfig(): StoredConfig$4;
+    validateConfigUpdate(oldConfig: StoredConfig$4, newConfig: StoredConfig$4): void;
+    validateConfig(config: StoredConfig$4): void;
 }
 
-type StoredConfig$1 = {
+type StoredConfig$3 = {
     model: string;
     revision: string;
     quantized: boolean;
@@ -1883,13 +1890,13 @@ declare class TransformersEmbeddingFunction implements IEmbeddingFunction {
     static import(): Promise<{
         pipeline: typeof _xenova_transformers;
     }>;
-    buildFromConfig(config: StoredConfig$1): TransformersEmbeddingFunction;
-    getConfig(): StoredConfig$1;
-    validateConfigUpdate(oldConfig: StoredConfig$1, newConfig: StoredConfig$1): void;
-    validateConfig(config: StoredConfig$1): void;
+    buildFromConfig(config: StoredConfig$3): TransformersEmbeddingFunction;
+    getConfig(): StoredConfig$3;
+    validateConfigUpdate(oldConfig: StoredConfig$3, newConfig: StoredConfig$3): void;
+    validateConfig(config: StoredConfig$3): void;
 }
 
-type StoredConfig = {
+type StoredConfig$2 = {
     api_key_env_var: string;
     model_name: string;
 };
@@ -1906,9 +1913,56 @@ declare class VoyageAIEmbeddingFunction implements IEmbeddingFunction {
     });
     private initClient;
     generate(texts: string[]): Promise<number[][]>;
-    buildFromConfig(config: StoredConfig): VoyageAIEmbeddingFunction;
+    buildFromConfig(config: StoredConfig$2): VoyageAIEmbeddingFunction;
+    getConfig(): StoredConfig$2;
+    validateConfigUpdate(oldConfig: StoredConfig$2, newConfig: StoredConfig$2): void;
+    validateConfig(config: StoredConfig$2): void;
+}
+
+type StoredConfig$1 = {
+    account_id: string;
+    model_name: string;
+    api_key_env_var: string;
+    gateway_id?: string;
+};
+declare class CloudflareWorkersAIEmbeddingFunction implements IEmbeddingFunction {
+    name: string;
+    private account_id;
+    private model_name;
+    private api_key_env_var;
+    private gateway_id?;
+    private api_url;
+    private headers;
+    constructor({ cloudflare_api_key, model_name, account_id, api_key_env_var, gateway_id, }: {
+        cloudflare_api_key?: string;
+        model_name: string;
+        account_id: string;
+        api_key_env_var: string;
+        gateway_id?: string;
+    });
+    generate(texts: string[]): Promise<any>;
+    buildFromConfig(config: StoredConfig$1): CloudflareWorkersAIEmbeddingFunction;
+    getConfig(): StoredConfig$1;
+    validateConfig(config: StoredConfig$1): void;
+}
+
+type StoredConfig = {
+    model_name: string;
+    api_key_env_var: string;
+};
+declare class TogetherAIEmbeddingFunction implements IEmbeddingFunction {
+    name: string;
+    private model_name;
+    private api_key_env_var;
+    private headers;
+    constructor({ together_ai_api_key, model_name, api_key_env_var, }: {
+        together_ai_api_key?: string;
+        model_name: string;
+        api_key_env_var: string;
+    });
+    generate(texts: string[]): Promise<number[][]>;
+    buildFromConfig(config: StoredConfig): IEmbeddingFunction;
     getConfig(): StoredConfig;
-    validateConfigUpdate(oldConfig: StoredConfig, newConfig: StoredConfig): void;
     validateConfig(config: StoredConfig): void;
 }
 
@@ -1945,6 +1999,8 @@ declare const schemaMap: {
     text2vec: Schema;
     transformers: Schema;
     voyageai: Schema;
+    cloudflare_workers_ai: Schema;
+    together_ai: Schema;
 };
 /**
  * Load a JSON schema.
@@ -2053,4 +2109,4 @@ declare class ChromaUniqueError extends Error {
 }
 declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
 
-export { type AddRecordsParams, AdminClient, ChromaClient, ChromaClientError, type ChromaClientParams, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, CohereEmbeddingFunction, Collection, type CollectionMetadata, type CollectionParams, type CreateCollectionParams, DefaultEmbeddingFunction, type DeleteCollectionParams, type DeleteParams, type Document, type Documents, type Embedding, type Embeddings, type GetCollectionParams, type GetOrCreateCollectionParams, type GetParams, type GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, type ID, type IDs, type IEmbeddingFunction, IncludeEnum, InvalidArgumentError, InvalidCollectionError, JinaEmbeddingFunction, type ListCollectionsParams, type Metadata, type Metadatas, type ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, type PeekParams, type QueryRecordsParams, type QueryResponse, TransformersEmbeddingFunction, type UpdateRecordsParams, type UpsertRecordsParams, VoyageAIEmbeddingFunction, type Where, type WhereDocument, createErrorByType, getAvailableSchemas, getSchemaInfo, getSchemaVersion, loadSchema, validateConfigSchema };
+export { type AddRecordsParams, AdminClient, ChromaClient, ChromaClientError, type ChromaClientParams, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, CloudflareWorkersAIEmbeddingFunction, CohereEmbeddingFunction, Collection, type CollectionMetadata, type CollectionParams, type CreateCollectionParams, DefaultEmbeddingFunction, type DeleteCollectionParams, type DeleteParams, type Document, type Documents, type Embedding, type Embeddings, type GetCollectionParams, type GetOrCreateCollectionParams, type GetParams, type GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, type ID, type IDs, type IEmbeddingFunction, IncludeEnum, InvalidArgumentError, InvalidCollectionError, JinaEmbeddingFunction, type ListCollectionsParams, type Metadata, type Metadatas, type ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, type PeekParams, type QueryRecordsParams, type QueryResponse, TogetherAIEmbeddingFunction, TransformersEmbeddingFunction, type UpdateRecordsParams, type UpsertRecordsParams, VoyageAIEmbeddingFunction, type Where, type WhereDocument, createErrorByType, getAvailableSchemas, getSchemaInfo, getSchemaVersion, loadSchema, validateConfigSchema };