chromadb 1.8.1 → 1.9.1

package/dist/chromadb.d.ts

@@ -3,6 +3,148 @@ import * as _xenova_transformers from '@xenova/transformers';
 import * as chromadb_default_embed from 'chromadb-default-embed';
 import * as _google_generative_ai from '@google/generative-ai';
 
+type AuthHeaders = {
+    [header: string]: string;
+};
+type TokenHeaderType = "AUTHORIZATION" | "X_CHROMA_TOKEN";
+type AuthOptions = {
+    provider: ClientAuthProvider | string | undefined;
+    credentials?: any | undefined;
+    tokenHeaderType?: TokenHeaderType | undefined;
+};
+interface ClientAuthProvider {
+    /**
+     * Abstract method for authenticating a client.
+     */
+    authenticate(): AuthHeaders;
+}
+
+interface IEmbeddingFunction {
+    generate(texts: string[]): Promise<number[][]>;
+}
+
+declare enum IncludeEnum {
+    Documents = "documents",
+    Embeddings = "embeddings",
+    Metadatas = "metadatas",
+    Distances = "distances"
+}
+type Number = number;
+type Embedding = Array<Number>;
+type Embeddings = Array<Embedding>;
+type Metadata = Record<string, string | number | boolean>;
+type Metadatas = Array<Metadata>;
+type Document = string;
+type Documents = Array<Document>;
+type ID = string;
+type IDs = ID[];
+type PositiveInteger = number;
+type LiteralValue = string | number | boolean;
+type ListLiteralValue = LiteralValue[];
+type LiteralNumber = number;
+type LogicalOperator = "$and" | "$or";
+type InclusionOperator = "$in" | "$nin";
+type WhereOperator = "$gt" | "$gte" | "$lt" | "$lte" | "$ne" | "$eq";
+type OperatorExpression = {
+    [key in WhereOperator | InclusionOperator | LogicalOperator]?: LiteralValue | ListLiteralValue;
+};
+type BaseWhere = {
+    [key: string]: LiteralValue | OperatorExpression;
+};
+type LogicalWhere = {
+    [key in LogicalOperator]?: Where[];
+};
+type Where = BaseWhere | LogicalWhere;
+type WhereDocumentOperator = "$contains" | "$not_contains" | LogicalOperator;
+type WhereDocument = {
+    [key in WhereDocumentOperator]?: LiteralValue | LiteralNumber | WhereDocument[];
+};
+type CollectionType = {
+    name: string;
+    id: string;
+    metadata: Metadata | null;
+};
+type GetResponse = {
+    ids: IDs;
+    embeddings: null | Embeddings;
+    documents: (null | Document)[];
+    metadatas: (null | Metadata)[];
+    error: null | string;
+    included: IncludeEnum[];
+};
+type QueryResponse = {
+    ids: IDs[];
+    embeddings: null | Embeddings[];
+    documents: (null | Document)[][];
+    metadatas: (null | Metadata)[][];
+    distances: null | number[][];
+    included: IncludeEnum[];
+};
+type AddResponse = {
+    error: string;
+};
+type CollectionMetadata = Record<string, unknown>;
+type GetParams = {
+    ids?: ID | IDs;
+    where?: Where;
+    limit?: PositiveInteger;
+    offset?: PositiveInteger;
+    include?: IncludeEnum[];
+    whereDocument?: WhereDocument;
+};
+type ListCollectionsParams = {
+    limit?: PositiveInteger;
+    offset?: PositiveInteger;
+};
+type ChromaClientParams = {
+    path?: string;
+    fetchOptions?: RequestInit;
+    auth?: AuthOptions;
+    tenant?: string;
+    database?: string;
+};
+type CreateCollectionParams = {
+    name: string;
+    metadata?: CollectionMetadata;
+    embeddingFunction?: IEmbeddingFunction;
+};
+type GetOrCreateCollectionParams = CreateCollectionParams;
+type GetCollectionParams = {
+    name: string;
+    embeddingFunction?: IEmbeddingFunction;
+};
+type DeleteCollectionParams = {
+    name: string;
+};
+type AddParams = {
+    ids: ID | IDs;
+    embeddings?: Embedding | Embeddings;
+    metadatas?: Metadata | Metadatas;
+    documents?: Document | Documents;
+};
+type UpsertParams = AddParams;
+type UpdateParams = AddParams;
+type ModifyCollectionParams = {
+    name?: string;
+    metadata?: CollectionMetadata;
+};
+type QueryParams = {
+    queryEmbeddings?: Embedding | Embeddings;
+    nResults?: PositiveInteger;
+    where?: Where;
+    queryTexts?: string | string[];
+    whereDocument?: WhereDocument;
+    include?: IncludeEnum[];
+};
+type PeekParams = {
+    limit?: PositiveInteger;
+};
+type DeleteParams = {
+    ids?: ID | IDs;
+    where?: Where;
+    whereDocument?: WhereDocument;
+};
+
 /**
  * FastAPI
  *
@@ -132,7 +274,7 @@ declare namespace Api {
     interface CreateCollection {
         name: string;
         metadata?: Api.CreateCollection.Metadata;
-        'get_or_create'?: boolean;
+        get_or_create?: boolean;
     }
     /**
      * @export
@@ -159,7 +301,7 @@ declare namespace Api {
     interface DeleteEmbedding {
         ids?: string[];
         where?: Api.DeleteEmbedding.Where;
-        'where_document'?: Api.DeleteEmbedding.WhereDocument;
+        where_document?: Api.DeleteEmbedding.WhereDocument;
     }
     /**
      * @export
@@ -178,7 +320,7 @@ declare namespace Api {
     interface GetEmbedding {
         ids?: string[];
         where?: Api.GetEmbedding.Where;
-        'where_document'?: Api.GetEmbedding.WhereDocument;
+        where_document?: Api.GetEmbedding.WhereDocument;
         sort?: string;
         /**
          * @type {number}
@@ -240,13 +382,13 @@ declare namespace Api {
     }
     interface QueryEmbedding {
         where?: Api.QueryEmbedding.Where;
-        'where_document'?: Api.QueryEmbedding.WhereDocument;
-        'query_embeddings': Api.QueryEmbedding.QueryEmbedding2[];
+        where_document?: Api.QueryEmbedding.WhereDocument;
+        query_embeddings: Api.QueryEmbedding.QueryEmbedding2[];
         /**
          * @type {number}
          * @memberof QueryEmbedding
          */
-        'n_results'?: number;
+        n_results?: number;
         include?: (Api.QueryEmbedding.Include.EnumValueEnum | Api.QueryEmbedding.Include.EnumValueEnum2 | Api.QueryEmbedding.Include.EnumValueEnum3 | Api.QueryEmbedding.Include.EnumValueEnum4 | Api.QueryEmbedding.Include.EnumValueEnum5 | Api.QueryEmbedding.Include.EnumValueEnum6)[];
     }
     /**
@@ -289,8 +431,8 @@ declare namespace Api {
     interface Update200Response {
     }
     interface UpdateCollection {
-        'new_name'?: string;
-        'new_metadata'?: Api.UpdateCollection.NewMetadata;
+        new_name?: string;
+        new_metadata?: Api.UpdateCollection.NewMetadata;
     }
     /**
      * @export
@@ -324,7 +466,7 @@ declare namespace Api {
     interface ValidationError {
         loc: (string | number)[];
         msg: string;
-        'type': string;
+        type: string;
     }
 }
 
@@ -521,170 +663,6 @@ declare class ApiApi extends BaseAPI {
     version(options?: RequestInit): Promise<string>;
 }
 
-interface ClientAuthProvider {
-    /**
-     * Abstract method for authenticating a client.
-     */
-    authenticate(): ClientAuthResponse;
-}
-interface ClientAuthConfigurationProvider<T> {
-    /**
-     * Abstract method for getting the configuration for the client.
-     */
-    getConfig(): T;
-}
-interface ClientAuthCredentialsProvider<T> {
-    /**
-     * Abstract method for getting the credentials for the client.
-     * @param user
-     */
-    getCredentials(user?: string): T;
-}
-declare enum AuthInfoType {
-    COOKIE = "cookie",
-    HEADER = "header",
-    URL = "url",
-    METADATA = "metadata"
-}
-interface ClientAuthResponse {
-    getAuthInfoType(): AuthInfoType;
-    getAuthInfo(): {
-        key: string;
-        value: string;
-    };
-}
-type AuthOptions = {
-    provider: ClientAuthProvider | string | undefined;
-    credentialsProvider?: ClientAuthCredentialsProvider<any> | undefined;
-    configProvider?: ClientAuthConfigurationProvider<any> | undefined;
-    credentials?: any | undefined;
-    providerOptions?: any | undefined;
-};
-
-interface IEmbeddingFunction {
-    generate(texts: string[]): Promise<number[][]>;
-}
-
-declare enum IncludeEnum {
-    Documents = "documents",
-    Embeddings = "embeddings",
-    Metadatas = "metadatas",
-    Distances = "distances"
-}
-type Number = number;
-type Embedding = Array<Number>;
-type Embeddings = Array<Embedding>;
-type Metadata = Record<string, string | number | boolean>;
-type Metadatas = Array<Metadata>;
-type Document = string;
-type Documents = Array<Document>;
-type ID = string;
-type IDs = ID[];
-type PositiveInteger = number;
-type LiteralValue = string | number | boolean;
-type ListLiteralValue = LiteralValue[];
-type LiteralNumber = number;
-type LogicalOperator = "$and" | "$or";
-type InclusionOperator = "$in" | "$nin";
-type WhereOperator = "$gt" | "$gte" | "$lt" | "$lte" | "$ne" | "$eq";
-type OperatorExpression = {
-    [key in WhereOperator | InclusionOperator | LogicalOperator]?: LiteralValue | ListLiteralValue;
-};
-type BaseWhere = {
-    [key: string]: LiteralValue | OperatorExpression;
-};
-type LogicalWhere = {
-    [key in LogicalOperator]?: Where[];
-};
-type Where = BaseWhere | LogicalWhere;
-type WhereDocumentOperator = "$contains" | LogicalOperator;
-type WhereDocument = {
-    [key in WhereDocumentOperator]?: LiteralValue | LiteralNumber | WhereDocument[];
-};
-type CollectionType = {
-    name: string;
-    id: string;
-    metadata: Metadata | null;
-};
-type GetResponse = {
-    ids: IDs;
-    embeddings: null | Embeddings;
-    documents: (null | Document)[];
-    metadatas: (null | Metadata)[];
-    error: null | string;
-};
-type QueryResponse = {
-    ids: IDs[];
-    embeddings: null | Embeddings[];
-    documents: (null | Document)[][];
-    metadatas: (null | Metadata)[][];
-    distances: null | number[][];
-};
-type AddResponse = {
-    error: string;
-};
-type CollectionMetadata = Record<string, unknown>;
-type GetParams = {
-    ids?: ID | IDs;
-    where?: Where;
-    limit?: PositiveInteger;
-    offset?: PositiveInteger;
-    include?: IncludeEnum[];
-    whereDocument?: WhereDocument;
-};
-type ListCollectionsParams = {
-    limit?: PositiveInteger;
-    offset?: PositiveInteger;
-};
-type ChromaClientParams = {
-    path?: string;
-    fetchOptions?: RequestInit;
-    auth?: AuthOptions;
-    tenant?: string;
-    database?: string;
-};
-type CreateCollectionParams = {
-    name: string;
-    metadata?: CollectionMetadata;
-    embeddingFunction?: IEmbeddingFunction;
-};
-type GetOrCreateCollectionParams = CreateCollectionParams;
-type GetCollectionParams = {
-    name: string;
-    embeddingFunction?: IEmbeddingFunction;
-};
-type DeleteCollectionParams = {
-    name: string;
-};
-type AddParams = {
-    ids: ID | IDs;
-    embeddings?: Embedding | Embeddings;
-    metadatas?: Metadata | Metadatas;
-    documents?: Document | Documents;
-};
-type UpsertParams = AddParams;
-type UpdateParams = AddParams;
-type ModifyCollectionParams = {
-    name?: string;
-    metadata?: CollectionMetadata;
-};
-type QueryParams = {
-    queryEmbeddings?: Embedding | Embeddings;
-    nResults?: PositiveInteger;
-    where?: Where;
-    queryTexts?: string | string[];
-    whereDocument?: WhereDocument;
-    include?: IncludeEnum[];
-};
-type PeekParams = {
-    limit?: PositiveInteger;
-};
-type DeleteParams = {
-    ids?: ID | IDs;
-    where?: Where;
-    whereDocument?: WhereDocument;
-};
-
 declare class Collection {
     name: string;
     id: string;
@@ -720,7 +698,7 @@ declare class Collection {
      * @param {Embedding | Embeddings} [params.embeddings] - Optional embeddings of the items to add.
      * @param {Metadata | Metadatas} [params.metadatas] - Optional metadata of the items to add.
      * @param {Document | Documents} [params.documents] - Optional documents of the items to add.
-    * @returns {Promise<AddResponse>} - The response from the API. True if successful.
+     * @returns {Promise<AddResponse>} - The response from the API. True if successful.
      *
      * @example
      * ```typescript
@@ -778,7 +756,7 @@ declare class Collection {
      * });
      * ```
      */
-    modify({ name, metadata }?: ModifyCollectionParams): Promise<void>;
+    modify({ name, metadata, }?: ModifyCollectionParams): Promise<void>;
     /**
      * Get items from the collection
      * @param {Object} params - The parameters for the query.
@@ -890,7 +868,7 @@ declare class Collection {
      * });
      * ```
      */
-    delete({ ids, where, whereDocument }?: DeleteParams): Promise<string[]>;
+    delete({ ids, where, whereDocument, }?: DeleteParams): Promise<string[]>;
 }
 
 declare class ChromaClient {
@@ -898,10 +876,10 @@ declare class ChromaClient {
      * @ignore
      */
     private api;
-    private apiAdapter;
     private tenant;
     private database;
     private _adminClient?;
+    private authProvider;
     /**
      * Creates a new ChromaClient instance.
      * @param {Object} params - The parameters for creating a new client
@@ -920,7 +898,8 @@ declare class ChromaClient {
      * Resets the state of the object by making an API call to the reset endpoint.
      *
      * @returns {Promise<boolean>} A promise that resolves when the reset operation is complete.
-     * @throws {Error} If there is an issue resetting the state.
+     * @throws {ChromaConnectionError} If the client is unable to connect to the server.
+     * @throws {ChromaServerError} If the server experienced an error while the state.
      *
      * @example
      * ```typescript
@@ -931,6 +910,7 @@ declare class ChromaClient {
     /**
      * Returns the version of the Chroma API.
      * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+     * @throws {ChromaConnectionError} If the client is unable to connect to the server.
      *
      * @example
      * ```typescript
@@ -941,6 +921,7 @@ declare class ChromaClient {
     /**
      * Returns a heartbeat from the Chroma API.
      * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+     * @throws {ChromaConnectionError} If the client is unable to connect to the server.
      *
      * @example
      * ```typescript
@@ -957,7 +938,8 @@ declare class ChromaClient {
      * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
      *
      * @returns {Promise<Collection>} A promise that resolves to the created collection.
-     * @throws {Error} If there is an issue creating the collection.
+     * @throws {ChromaConnectionError} If the client is unable to connect to the server.
+     * @throws {ChromaServerError} If there is an issue creating the collection.
      *
      * @example
      * ```typescript
@@ -969,7 +951,7 @@ declare class ChromaClient {
      * });
      * ```
      */
-    createCollection({ name, metadata, embeddingFunction }: CreateCollectionParams): Promise<Collection>;
+    createCollection({ name, metadata, embeddingFunction, }: CreateCollectionParams): Promise<Collection>;
     /**
      * Gets or creates a collection with the specified properties.
      *
@@ -991,7 +973,7 @@ declare class ChromaClient {
      * });
      * ```
      */
-    getOrCreateCollection({ name, metadata, embeddingFunction }: GetOrCreateCollectionParams): Promise<Collection>;
+    getOrCreateCollection({ name, metadata, embeddingFunction, }: GetOrCreateCollectionParams): Promise<Collection>;
     /**
      * Lists all collections.
      *
@@ -1036,7 +1018,7 @@ declare class ChromaClient {
      * });
      * ```
      */
-    getCollection({ name, embeddingFunction }: GetCollectionParams): Promise<Collection>;
+    getCollection({ name, embeddingFunction, }: GetCollectionParams): Promise<Collection>;
     /**
      * Deletes a collection with the specified name.
      * @param {Object} params - The parameters for deleting a collection.
@@ -1051,7 +1033,7 @@ declare class ChromaClient {
      * });
      * ```
      */
-    deleteCollection({ name }: DeleteCollectionParams): Promise<void>;
+    deleteCollection({ name, }: DeleteCollectionParams): Promise<void>;
 }
 
 interface Tenant {
@@ -1065,7 +1047,7 @@ declare class AdminClient {
      * @ignore
      */
     private api;
-    private apiAdapter;
+    private authProvider;
     tenant: string;
     database: string;
     /**
@@ -1081,7 +1063,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    constructor({ path, fetchOptions, auth, tenant, database }?: {
+    constructor({ path, fetchOptions, auth, tenant, database, }?: {
         path?: string;
         fetchOptions?: RequestInit;
         auth?: AuthOptions;
@@ -1106,7 +1088,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    setTenant({ tenant, database }: {
+    setTenant({ tenant, database, }: {
         tenant: string;
         database?: string;
     }): Promise<void>;
@@ -1126,7 +1108,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    setDatabase({ database }: {
+    setDatabase({ database, }: {
         database?: string;
     }): Promise<void>;
     /**
@@ -1145,7 +1127,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    createTenant({ name, }: {
+    createTenant({ name }: {
         name: string;
     }): Promise<Tenant>;
     /**
@@ -1164,7 +1146,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    getTenant({ name, }: {
+    getTenant({ name }: {
         name: string;
     }): Promise<Tenant>;
     /**
@@ -1185,7 +1167,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    createDatabase({ name, tenantName }: {
+    createDatabase({ name, tenantName, }: {
         name: string;
         tenantName: string;
     }): Promise<Database>;
@@ -1207,7 +1189,7 @@ declare class AdminClient {
      * });
      * ```
      */
-    getDatabase({ name, tenantName }: {
+    getDatabase({ name, tenantName, }: {
         name: string;
         tenantName: string;
     }): Promise<Database>;
@@ -1228,7 +1210,7 @@ declare class OpenAIEmbeddingFunction implements IEmbeddingFunction {
     private org_id;
     private model;
     private openaiApi?;
-    constructor({ openai_api_key, openai_model, openai_organization_id }: {
+    constructor({ openai_api_key, openai_model, openai_organization_id, }: {
         openai_api_key: string;
         openai_model?: string;
         openai_organization_id?: string;
@@ -1324,7 +1306,7 @@ declare class JinaEmbeddingFunction implements IEmbeddingFunction {
     private model_name;
     private api_url;
     private headers;
-    constructor({ jinaai_api_key, model_name }: {
+    constructor({ jinaai_api_key, model_name, }: {
         jinaai_api_key: string;
         model_name?: string;
     });
@@ -1336,7 +1318,7 @@ declare class GoogleGenerativeAiEmbeddingFunction implements IEmbeddingFunction
     private model;
     private googleGenAiApi?;
     private taskType;
-    constructor({ googleApiKey, model, taskType }: {
+    constructor({ googleApiKey, model, taskType, }: {
         googleApiKey: string;
         model?: string;
         taskType?: string;
@@ -1349,4 +1331,14 @@ declare class GoogleGenerativeAiEmbeddingFunction implements IEmbeddingFunction
     }>;
 }
 
-export { AddParams, AdminClient, ChromaClient, ChromaClientParams, CloudClient, CohereEmbeddingFunction, Collection, CollectionMetadata, CollectionType, CreateCollectionParams, DefaultEmbeddingFunction, DeleteCollectionParams, DeleteParams, Document, Documents, Embedding, Embeddings, GetCollectionParams, GetOrCreateCollectionParams, GetParams, GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, ID, IDs, IEmbeddingFunction, IncludeEnum, JinaEmbeddingFunction, ListCollectionsParams, Metadata, Metadatas, ModifyCollectionParams, OpenAIEmbeddingFunction, PeekParams, QueryParams, QueryResponse, TransformersEmbeddingFunction, UpdateParams, UpsertParams, Where, WhereDocument };
+declare class OllamaEmbeddingFunction implements IEmbeddingFunction {
+    private readonly url;
+    private readonly model;
+    constructor({ url, model }: {
+        url: string;
+        model: string;
+    });
+    generate(texts: string[]): Promise<number[][]>;
+}
+
+export { AddParams, AdminClient, ChromaClient, ChromaClientParams, CloudClient, CohereEmbeddingFunction, Collection, CollectionMetadata, CollectionType, CreateCollectionParams, DefaultEmbeddingFunction, DeleteCollectionParams, DeleteParams, Document, Documents, Embedding, Embeddings, GetCollectionParams, GetOrCreateCollectionParams, GetParams, GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, ID, IDs, IEmbeddingFunction, IncludeEnum, JinaEmbeddingFunction, ListCollectionsParams, Metadata, Metadatas, ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, PeekParams, QueryParams, QueryResponse, TransformersEmbeddingFunction, UpdateParams, UpsertParams, Where, WhereDocument };