chromadb 3.0.1 → 3.0.2

package/dist/chromadb.d.ts

@@ -1,14 +1,12 @@
-import { createClient } from '@hey-api/client-fetch';
-
 type Database = {
     id: string;
     name: string;
     tenant: string;
 };
 type EmbeddingFunctionConfiguration = {
-    type: "legacy";
+    type: 'legacy';
 } | (EmbeddingFunctionNewConfiguration & {
-    type: "known";
+    type: 'known';
 });
 type EmbeddingFunctionNewConfiguration = {
     config: unknown;
@@ -27,8 +25,8 @@ type HnswConfiguration = {
     space?: HnswSpace;
     sync_threshold?: number | null;
 };
-type HnswSpace = "l2" | "cosine" | "ip";
-type Include = "distances" | "documents" | "embeddings" | "metadatas" | "uris";
+type HnswSpace = 'l2' | 'cosine' | 'ip';
+type Include = 'distances' | 'documents' | 'embeddings' | 'metadatas' | 'uris';
 type SpannConfiguration = {
     ef_construction?: number | null;
     ef_search?: number | null;
@@ -62,12 +60,12 @@ type UserIdentity = GetUserIdentityResponse;
  * Metadata that can be associated with a collection.
  * Values must be boolean, number, or string types.
  */
-type CollectionMetadata = Record<string, boolean | number | string>;
+type CollectionMetadata = Record<string, boolean | number | string | null>;
 /**
  * Metadata that can be associated with individual records.
  * Values must be boolean, number, or string types.
  */
-type Metadata = Record<string, boolean | number | string>;
+type Metadata = Record<string, boolean | number | string | null>;
 /**
  * Base interface for record sets containing optional fields.
  */
@@ -196,38 +194,30 @@ declare class GetResult<TMeta extends Metadata = Metadata> {
      * @returns Object containing include fields and array of record objects
      */
     rows(): {
-        include: Include[];
-        records: {
-            id: string;
-            document: string | null | undefined;
-            embedding: number[] | undefined;
-            metadata: TMeta | null | undefined;
-            uri: string | null | undefined;
-        }[];
-    };
+        id: string;
+        document: string | null | undefined;
+        embedding: number[] | undefined;
+        metadata: TMeta | null | undefined;
+        uri: string | null | undefined;
+    }[];
 }
 /**
  * Interface for query results in row format.
  * @template TMeta - The type of metadata associated with records
  */
 interface QueryRowResult<TMeta extends Metadata = Metadata> {
-    /** Fields included in the query results */
-    include: Include[];
-    /** Array of query results, with each query returning an array of matches */
-    queries: {
-        /** Similarity distance to the query (if included) */
-        distance?: number | null;
-        /** Document text content (if included) */
-        document?: string | null;
-        /** Embedding vector (if included) */
-        embedding?: number[] | null;
-        /** Unique record identifier */
-        id: string;
-        /** Record metadata (if included) */
-        metadata?: TMeta | null;
-        /** Record URI (if included) */
-        uri?: string | null;
-    }[][];
+    /** Similarity distance to the query (if included) */
+    distance?: number | null;
+    /** Document text content (if included) */
+    document?: string | null;
+    /** Embedding vector (if included) */
+    embedding?: number[] | null;
+    /** Unique record identifier */
+    id: string;
+    /** Record metadata (if included) */
+    metadata?: TMeta | null;
+    /** Record URI (if included) */
+    uri?: string | null;
 }
 /**
  * Result class for query operations, containing search results.
@@ -258,7 +248,7 @@ declare class QueryResult<TMeta extends Metadata = Metadata> {
      * Converts the query result to a row-based format for easier iteration.
      * @returns Object containing include fields and structured query results
      */
-    rows(): QueryRowResult<TMeta>;
+    rows(): QueryRowResult<TMeta>[][];
 }
 
 /**
@@ -414,6 +404,10 @@ interface ChromaClientArgs {
     headers?: Record<string, string>;
     /** Additional fetch options for HTTP requests */
     fetchOptions?: RequestInit;
+    /** @deprecated Use host, port, and ssl instead */
+    path?: string;
+    /** @deprecated */
+    auth?: Record<string, string>;
 }
 /**
  * Main client class for interacting with ChromaDB.
@@ -507,7 +501,7 @@ declare class ChromaClient {
     getCollections(items: string[] | {
         name: string;
         embeddingFunction?: EmbeddingFunction;
-    }[]): Promise<void[]>;
+    }[]): Promise<Collection[]>;
     /**
      * Gets an existing collection or creates it if it doesn't exist.
      * @param options - Collection options
@@ -542,35 +536,21 @@ declare class ChromaClient {
      * @returns Promise resolving to the server version string
      */
     version(): Promise<string>;
-    /**
-     * Creates a thin CollectionAPI instance for direct collection operations by ID.
-     * @param options - Collection API options
-     * @param options.id - The collection ID
-     * @param options.embeddingFunction - Optional embedding function to use
-     * @returns A CollectionAPI instance for the specified collection
-     */
-    getCollectionById({ id, embeddingFunction, }: {
-        id: string;
-        embeddingFunction?: EmbeddingFunction;
-    }): CollectionAPI;
-    /**
-     * Creates multiple thin CollectionAPI instances for direct collection operations by ID.
-     * @param items - Array of collection IDs or objects with ID and optional embedding function
-     * @returns Array of CollectionAPI instances
-     */
-    getCollectionsById(items: string[] | {
-        id: string;
-        embeddingFunction?: EmbeddingFunction;
-    }[]): CollectionAPIImpl[];
 }
 
 /**
  * Interface for collection operations using collection ID.
  * Provides methods for adding, querying, updating, and deleting records.
  */
-interface CollectionAPI {
+interface Collection {
     /** Unique identifier for the collection */
     id: string;
+    /** Name of the collection */
+    name: string;
+    /** Collection-level metadata */
+    metadata: CollectionMetadata | undefined;
+    /** Collection configuration settings */
+    configuration: CollectionConfiguration;
     /** Optional embedding function. Must match the one used to create the collection. */
     embeddingFunction?: EmbeddingFunction;
     /** Gets the total number of records in the collection */
@@ -708,105 +688,6 @@ interface CollectionAPI {
         whereDocument?: WhereDocument;
     }): Promise<void>;
 }
-/**
- * A Chroma collection retrieved by name, with its metadata and configuration.
- */
-interface Collection extends CollectionAPI {
-    /** Human-readable name of the collection */
-    name: string;
-    /** Collection-level metadata */
-    metadata: CollectionMetadata | undefined;
-    /** Collection configuration settings */
-    configuration: CollectionConfiguration;
-}
-/**
- * Implementation of CollectionAPI for ID-based collection operations.
- * Provides core functionality for interacting with collections using their ID.
- */
-declare class CollectionAPIImpl implements CollectionAPI {
-    protected readonly chromaClient: ChromaClient;
-    protected readonly apiClient: ReturnType<typeof createClient>;
-    readonly id: string;
-    protected _embeddingFunction: EmbeddingFunction | undefined;
-    /**
-     * Creates a new CollectionAPIImpl instance.
-     * @param options - Configuration for the collection API
-     */
-    constructor({ chromaClient, apiClient, id, embeddingFunction, }: {
-        chromaClient: ChromaClient;
-        apiClient: ReturnType<typeof createClient>;
-        id: string;
-        embeddingFunction?: EmbeddingFunction;
-    });
-    get embeddingFunction(): EmbeddingFunction | undefined;
-    protected set embeddingFunction(embeddingFunction: EmbeddingFunction | undefined);
-    protected path(): Promise<{
-        tenant: string;
-        database: string;
-        collection_id: string;
-    }>;
-    private embed;
-    private prepareRecords;
-    private validateGet;
-    private prepareQuery;
-    private validateDelete;
-    count(): Promise<number>;
-    add({ ids, embeddings, metadatas, documents, uris, }: {
-        ids: string[];
-        embeddings?: number[][];
-        metadatas?: Metadata[];
-        documents?: string[];
-        uris?: string[];
-    }): Promise<void>;
-    get<TMeta extends Metadata = Metadata>(args?: Partial<{
-        ids?: string[];
-        where?: Where;
-        limit?: number;
-        offset?: number;
-        whereDocument?: WhereDocument;
-        include?: Include[];
-    }>): Promise<GetResult<TMeta>>;
-    peek({ limit }: {
-        limit?: number;
-    }): Promise<GetResult>;
-    query<TMeta extends Metadata = Metadata>({ queryEmbeddings, queryTexts, queryURIs, ids, nResults, where, whereDocument, include, }: {
-        queryEmbeddings?: number[][];
-        queryTexts?: string[];
-        queryURIs?: string[];
-        ids?: string[];
-        nResults?: number;
-        where?: Where;
-        whereDocument?: WhereDocument;
-        include?: Include[];
-    }): Promise<QueryResult<TMeta>>;
-    modify({ name, metadata, configuration, }: {
-        name?: string;
-        metadata?: CollectionMetadata;
-        configuration?: UpdateCollectionConfiguration;
-    }): Promise<void>;
-    fork({ name }: {
-        name: string;
-    }): Promise<Collection>;
-    update({ ids, embeddings, metadatas, documents, uris, }: {
-        ids: string[];
-        embeddings?: number[][];
-        metadatas?: Metadata[];
-        documents?: string[];
-        uris?: string[];
-    }): Promise<void>;
-    upsert({ ids, embeddings, metadatas, documents, uris, }: {
-        ids: string[];
-        embeddings?: number[][];
-        metadatas?: Metadata[];
-        documents?: string[];
-        uris?: string[];
-    }): Promise<void>;
-    delete({ ids, where, whereDocument, }: {
-        ids?: string[];
-        where?: Where;
-        whereDocument?: WhereDocument;
-    }): Promise<void>;
-}
 
 declare function withChroma(userNextConfig?: any): any;
 
@@ -1012,4 +893,4 @@ declare class ChromaQuotaExceededError extends Error {
 }
 declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
 
-export { AdminClient, type AdminClientArgs, AdminCloudClient, type BaseRecordSet, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, type Collection, type CollectionAPI, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, GetResult, type HNSWConfiguration, IncludeEnum, InvalidArgumentError, InvalidCollectionError, type ListDatabasesArgs, type Metadata, type QueryRecordSet, QueryResult, type QueryRowResult, type RecordSet, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, type Where, type WhereDocument, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, knownEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, serializeEmbeddingFunction, withChroma };
+export { AdminClient, type AdminClientArgs, AdminCloudClient, type BaseRecordSet, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, type Collection, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, GetResult, type HNSWConfiguration, IncludeEnum, InvalidArgumentError, InvalidCollectionError, type ListDatabasesArgs, type Metadata, type QueryRecordSet, QueryResult, type QueryRowResult, type RecordSet, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, type Where, type WhereDocument, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, knownEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, serializeEmbeddingFunction, withChroma };