chromadb 1.4.2 → 1.5.1

package/dist/main/ChromaClient.d.ts

@@ -0,0 +1,163 @@
+import { IEmbeddingFunction } from './embeddings/IEmbeddingFunction';
+import { Api } from "./generated";
+import { Collection } from './Collection';
+import { CollectionMetadata, CollectionType } from './types';
+export declare class ChromaClient {
+    /**
+     * @ignore
+     */
+    private api;
+    /**
+     * Creates a new ChromaClient instance.
+     * @param {Object} params - The parameters for creating a new client
+     * @param {string} [params.path] - The base path for the Chroma API.
+     * @returns {ChromaClient} A new ChromaClient instance.
+     *
+     * @example
+     * ```typescript
+     * const client = new ChromaClient({
+     *   path: "http://localhost:8000"
+     * });
+     * ```
+     */
+    constructor({ path }?: {
+        path?: string;
+    });
+    /**
+     * Resets the state of the object by making an API call to the reset endpoint.
+     *
+     * @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
+     * @throws {Error} If there is an issue resetting the state.
+     *
+     * @example
+     * ```typescript
+     * await client.reset();
+     * ```
+     */
+    reset(): Promise<Api.Reset200Response>;
+    /**
+     * Returns the version of the Chroma API.
+     * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const version = await client.version();
+     * ```
+     */
+    version(): Promise<string>;
+    /**
+     * Returns a heartbeat from the Chroma API.
+     * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const heartbeat = await client.heartbeat();
+     * ```
+     */
+    heartbeat(): Promise<number>;
+    /**
+     * @ignore
+     */
+    persist(): Promise<never>;
+    /**
+     * Creates a new collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @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.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.createCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    createCollection({ name, metadata, embeddingFunction }: {
+        name: string;
+        metadata?: CollectionMetadata;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Gets or creates a collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the got or created collection.
+     * @throws {Error} If there is an issue getting or creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getOrCreateCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    getOrCreateCollection({ name, metadata, embeddingFunction }: {
+        name: string;
+        metadata?: CollectionMetadata;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Lists all collections.
+     *
+     * @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
+     * @throws {Error} If there is an issue listing the collections.
+     *
+     * @example
+     * ```typescript
+     * const collections = await client.listCollections();
+     * ```
+     */
+    listCollections(): Promise<CollectionType[]>;
+    /**
+     * Gets a collection with the specified name.
+     * @param {Object} params - The parameters for getting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     * @returns {Promise<Collection>} A promise that resolves to the collection.
+     * @throws {Error} If there is an issue getting the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getCollection({
+     *   name: "my_collection"
+     * });
+     * ```
+     */
+    getCollection({ name, embeddingFunction }: {
+        name: string;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Deletes a collection with the specified name.
+     * @param {Object} params - The parameters for deleting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+     * @throws {Error} If there is an issue deleting the collection.
+     *
+     * @example
+     * ```typescript
+     * await client.deleteCollection({
+     *  name: "my_collection"
+     * });
+     * ```
+     */
+    deleteCollection({ name }: {
+        name: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=ChromaClient.d.ts.map

package/dist/main/ChromaClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChromaClient.d.ts","sourceRoot":"","sources":["../../src/ChromaClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAuC,GAAG,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG7D,qBAAa,YAAY;IACrB;;OAEG;IACH,OAAO,CAAC,GAAG,CAAa;IAExB;;;;;;;;;;;;OAYG;gBACS,EAAE,IAAI,EAAE,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO;IAQ5C;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAInD;;;;;;;;OAQG;IACU,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvC;;;;;;;;OAQG;IACU,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAMzC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,gBAAgB,CAAC,EAC1B,IAAI,EACJ,QAAQ,EACR,iBAAiB,EACpB,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAC9B,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;KACzC,GAAG,OAAO,CAAC,UAAU,CAAC;IAgBvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,qBAAqB,CAAC,EAC/B,IAAI,EACJ,QAAQ,EACR,iBAAiB,EACpB,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAC9B,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;KACzC,GAAG,OAAO,CAAC,UAAU,CAAC;IAuBvB;;;;;;;;;;OAUG;IACU,eAAe,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAKzD;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,EACvB,IAAI,EACJ,iBAAiB,EACpB,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;KACzC,GAAG,OAAO,CAAC,UAAU,CAAC;IAevB;;;;;;;;;;;;;OAaG;IACU,gBAAgB,CAAC,EAC1B,IAAI,EACP,EAAE;QACC,IAAI,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;CAOpB"}

package/dist/main/ChromaClient.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChromaClient = void 0;
+const generated_1 = require("./generated");
+const utils_1 = require("./utils");
+const Collection_1 = require("./Collection");
+class ChromaClient {
+    /**
+     * Creates a new ChromaClient instance.
+     * @param {Object} params - The parameters for creating a new client
+     * @param {string} [params.path] - The base path for the Chroma API.
+     * @returns {ChromaClient} A new ChromaClient instance.
+     *
+     * @example
+     * ```typescript
+     * const client = new ChromaClient({
+     *   path: "http://localhost:8000"
+     * });
+     * ```
+     */
+    constructor({ path } = {}) {
+        if (path === undefined)
+            path = "http://localhost:8000";
+        const apiConfig = new generated_1.Configuration({
+            basePath: path,
+        });
+        this.api = new generated_1.ApiApi(apiConfig);
+    }
+    /**
+     * Resets the state of the object by making an API call to the reset endpoint.
+     *
+     * @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
+     * @throws {Error} If there is an issue resetting the state.
+     *
+     * @example
+     * ```typescript
+     * await client.reset();
+     * ```
+     */
+    async reset() {
+        return await this.api.reset();
+    }
+    /**
+     * Returns the version of the Chroma API.
+     * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const version = await client.version();
+     * ```
+     */
+    async version() {
+        const response = await this.api.version();
+        return await (0, utils_1.handleSuccess)(response);
+    }
+    /**
+     * Returns a heartbeat from the Chroma API.
+     * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const heartbeat = await client.heartbeat();
+     * ```
+     */
+    async heartbeat() {
+        const response = await this.api.heartbeat();
+        let ret = await (0, utils_1.handleSuccess)(response);
+        return ret["nanosecond heartbeat"];
+    }
+    /**
+     * @ignore
+     */
+    async persist() {
+        throw new Error("Not implemented in JS client");
+    }
+    /**
+     * Creates a new collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @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.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.createCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    async createCollection({ name, metadata, embeddingFunction }) {
+        const newCollection = await this.api
+            .createCollection({
+            name,
+            metadata,
+        })
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        if (newCollection.error) {
+            throw new Error(newCollection.error);
+        }
+        return new Collection_1.Collection(name, newCollection.id, this.api, metadata, embeddingFunction);
+    }
+    /**
+     * Gets or creates a collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the got or created collection.
+     * @throws {Error} If there is an issue getting or creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getOrCreateCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    async getOrCreateCollection({ name, metadata, embeddingFunction }) {
+        const newCollection = await this.api
+            .createCollection({
+            name,
+            metadata,
+            'get_or_create': true
+        })
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        if (newCollection.error) {
+            throw new Error(newCollection.error);
+        }
+        return new Collection_1.Collection(name, newCollection.id, this.api, newCollection.metadata, embeddingFunction);
+    }
+    /**
+     * Lists all collections.
+     *
+     * @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
+     * @throws {Error} If there is an issue listing the collections.
+     *
+     * @example
+     * ```typescript
+     * const collections = await client.listCollections();
+     * ```
+     */
+    async listCollections() {
+        const response = await this.api.listCollections();
+        return (0, utils_1.handleSuccess)(response);
+    }
+    /**
+     * Gets a collection with the specified name.
+     * @param {Object} params - The parameters for getting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     * @returns {Promise<Collection>} A promise that resolves to the collection.
+     * @throws {Error} If there is an issue getting the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getCollection({
+     *   name: "my_collection"
+     * });
+     * ```
+     */
+    async getCollection({ name, embeddingFunction }) {
+        const response = await this.api
+            .getCollection(name)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        return new Collection_1.Collection(response.name, response.id, this.api, response.metadata, embeddingFunction);
+    }
+    /**
+     * Deletes a collection with the specified name.
+     * @param {Object} params - The parameters for deleting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+     * @throws {Error} If there is an issue deleting the collection.
+     *
+     * @example
+     * ```typescript
+     * await client.deleteCollection({
+     *  name: "my_collection"
+     * });
+     * ```
+     */
+    async deleteCollection({ name }) {
+        return await this.api
+            .deleteCollection(name)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+    }
+}
+exports.ChromaClient = ChromaClient;
+//# sourceMappingURL=ChromaClient.js.map

package/dist/main/ChromaClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChromaClient.js","sourceRoot":"","sources":["../../src/ChromaClient.ts"],"names":[],"mappings":";;;AACA,2CAAuE;AACvE,mCAAqD;AACrD,6CAA0C;AAI1C,MAAa,YAAY;IAMrB;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,IAAI,KAAwB,EAAE;QACxC,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,GAAG,uBAAuB,CAAC;QACvD,MAAM,SAAS,GAAkB,IAAI,yBAAa,CAAC;YAC/C,QAAQ,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK;QACd,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO;QAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC1C,OAAO,MAAM,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,SAAS;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,GAAG,GAAG,MAAM,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,gBAAgB,CAAC,EAC1B,IAAI,EACJ,QAAQ,EACR,iBAAiB,EAKpB;QACG,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG;aAC/B,gBAAgB,CAAC;YACd,IAAI;YACJ,QAAQ;SACX,CAAC;aACD,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAExB,IAAI,aAAa,CAAC,KAAK,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACxC;QAED,OAAO,IAAI,uBAAU,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,qBAAqB,CAAC,EAC/B,IAAI,EACJ,QAAQ,EACR,iBAAiB,EAKpB;QACG,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG;aAC/B,gBAAgB,CAAC;YACd,IAAI;YACJ,QAAQ;YACR,eAAe,EAAE,IAAI;SACxB,CAAC;aACD,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAExB,IAAI,aAAa,CAAC,KAAK,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACxC;QAED,OAAO,IAAI,uBAAU,CACjB,IAAI,EACJ,aAAa,CAAC,EAAE,EAChB,IAAI,CAAC,GAAG,EACR,aAAa,CAAC,QAAQ,EACtB,iBAAiB,CACpB,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,eAAe;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;QAClD,OAAO,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,aAAa,CAAC,EACvB,IAAI,EACJ,iBAAiB,EAIpB;QACG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG;aAC1B,aAAa,CAAC,IAAI,CAAC;aACnB,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAExB,OAAO,IAAI,uBAAU,CACjB,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,EAAE,EACX,IAAI,CAAC,GAAG,EACR,QAAQ,CAAC,QAAQ,EACjB,iBAAiB,CACpB,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,gBAAgB,CAAC,EAC1B,IAAI,EAGP;QACG,OAAO,MAAM,IAAI,CAAC,GAAG;aAChB,gBAAgB,CAAC,IAAI,CAAC;aACtB,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;IAC5B,CAAC;CAEJ;AA5PD,oCA4PC"}

package/dist/main/Collection.d.ts

@@ -0,0 +1,249 @@
+import { IncludeEnum, Metadata, Metadatas, Embedding, Embeddings, Document, Documents, Where, WhereDocument, ID, IDs, PositiveInteger, GetResponse, QueryResponse, AddResponse, CollectionMetadata } from "./types";
+import { IEmbeddingFunction } from './embeddings/IEmbeddingFunction';
+import { ApiApi as DefaultApi } from "./generated";
+export declare class Collection {
+    name: string;
+    id: string;
+    metadata: CollectionMetadata | undefined;
+    /**
+     * @ignore
+     */
+    private api;
+    /**
+     * @ignore
+     */
+    embeddingFunction: IEmbeddingFunction | undefined;
+    /**
+     * @ignore
+     */
+    constructor(name: string, id: string, api: DefaultApi, metadata?: CollectionMetadata, embeddingFunction?: IEmbeddingFunction);
+    /**
+     * @ignore
+     */
+    private setName;
+    /**
+     * @ignore
+     */
+    private setMetadata;
+    /**
+     * @ignore
+     */
+    private validate;
+    /**
+     * Add items to the collection
+     * @param {Object} params - The parameters for the query.
+     * @param {ID | IDs} [params.ids] - IDs of the items to add.
+     * @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.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.add({
+     *   ids: ["id1", "id2"],
+     *   embeddings: [[1, 2, 3], [4, 5, 6]],
+     *   metadatas: [{ "key": "value" }, { "key": "value" }],
+     *   documents: ["document1", "document2"]
+     * });
+     * ```
+     */
+    add({ ids, embeddings, metadatas, documents, }: {
+        ids: ID | IDs;
+        embeddings?: Embedding | Embeddings;
+        metadatas?: Metadata | Metadatas;
+        documents?: Document | Documents;
+    }): Promise<AddResponse>;
+    /**
+     * Upsert items to the collection
+     * @param {Object} params - The parameters for the query.
+     * @param {ID | IDs} [params.ids] - IDs of the items to add.
+     * @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<boolean>} - The response from the API. True if successful.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.upsert({
+     *   ids: ["id1", "id2"],
+     *   embeddings: [[1, 2, 3], [4, 5, 6]],
+     *   metadatas: [{ "key": "value" }, { "key": "value" }],
+     *   documents: ["document1", "document2"],
+     * });
+     * ```
+     */
+    upsert({ ids, embeddings, metadatas, documents, }: {
+        ids: ID | IDs;
+        embeddings?: Embedding | Embeddings;
+        metadatas?: Metadata | Metadatas;
+        documents?: Document | Documents;
+    }): Promise<boolean>;
+    /**
+     * Count the number of items in the collection
+     * @returns {Promise<number>} - The response from the API.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.count();
+     * ```
+     */
+    count(): Promise<number>;
+    /**
+     * Modify the collection name or metadata
+     * @param {Object} params - The parameters for the query.
+     * @param {string} [params.name] - Optional new name for the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional new metadata for the collection.
+     * @returns {Promise<void>} - The response from the API.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.modify({
+     *   name: "new name",
+     *   metadata: { "key": "value" },
+     * });
+     * ```
+     */
+    modify({ name, metadata }?: {
+        name?: string;
+        metadata?: CollectionMetadata;
+    }): Promise<void>;
+    /**
+     * Get items from the collection
+     * @param {Object} params - The parameters for the query.
+     * @param {ID | IDs} [params.ids] - Optional IDs of the items to get.
+     * @param {Where} [params.where] - Optional where clause to filter items by.
+     * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
+     * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
+     * @param {IncludeEnum[]} [params.include] - Optional list of items to include in the response.
+     * @param {WhereDocument} [params.whereDocument] - Optional where clause to filter items by.
+     * @returns {Promise<GetResponse>} - The response from the server.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.get({
+     *   ids: ["id1", "id2"],
+     *   where: { "key": "value" },
+     *   limit: 10,
+     *   offset: 0,
+     *   include: ["embeddings", "metadatas", "documents"],
+     *   whereDocument: { $contains: "value" },
+     * });
+     * ```
+     */
+    get({ ids, where, limit, offset, include, whereDocument, }?: {
+        ids?: ID | IDs;
+        where?: Where;
+        limit?: PositiveInteger;
+        offset?: PositiveInteger;
+        include?: IncludeEnum[];
+        whereDocument?: WhereDocument;
+    }): Promise<GetResponse>;
+    /**
+     * Update the embeddings, documents, and/or metadatas of existing items
+     * @param {Object} params - The parameters for the query.
+     * @param {ID | IDs} [params.ids] - The IDs of the items to update.
+     * @param {Embedding | Embeddings} [params.embeddings] - Optional embeddings to update.
+     * @param {Metadata | Metadatas} [params.metadatas] - Optional metadatas to update.
+     * @param {Document | Documents} [params.documents] - Optional documents to update.
+     * @returns {Promise<boolean>} - The API Response. True if successful. Else, error.
+     *
+     * @example
+     * ```typescript
+     * const response = await collection.update({
+     *   ids: ["id1", "id2"],
+     *   embeddings: [[1, 2, 3], [4, 5, 6]],
+     *   metadatas: [{ "key": "value" }, { "key": "value" }],
+     *   documents: ["new document 1", "new document 2"],
+     * });
+     * ```
+     */
+    update({ ids, embeddings, metadatas, documents, }: {
+        ids: ID | IDs;
+        embeddings?: Embedding | Embeddings;
+        metadatas?: Metadata | Metadatas;
+        documents?: Document | Documents;
+    }): Promise<boolean>;
+    /**
+     * Performs a query on the collection using the specified parameters.
+     *
+     * @param {Object} params - The parameters for the query.
+     * @param {Embedding | Embeddings} [params.queryEmbeddings] - Optional query embeddings to use for the search.
+     * @param {PositiveInteger} [params.nResults] - Optional number of results to return (default is 10).
+     * @param {Where} [params.where] - Optional query condition to filter results based on metadata values.
+     * @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".
+     *
+     * @returns {Promise<QueryResponse>} A promise that resolves to the query results.
+     * @throws {Error} If there is an issue executing the query.
+     * @example
+     * // Query the collection using embeddings
+     * const results = await collection.query({
+     *   queryEmbeddings: [[0.1, 0.2, ...], ...],
+     *   nResults: 10,
+     *   where: {"name": {"$eq": "John Doe"}},
+     *   include: ["metadata", "document"]
+     * });
+     * @example
+     * ```js
+     * // Query the collection using query text
+     * const results = await collection.query({
+     *   queryTexts: "some text",
+     *   nResults: 10,
+     *   where: {"name": {"$eq": "John Doe"}},
+     *   include: ["metadata", "document"]
+     * });
+     * ```
+     *
+     */
+    query({ queryEmbeddings, nResults, where, queryTexts, whereDocument, include, }: {
+        queryEmbeddings?: Embedding | Embeddings;
+        nResults?: PositiveInteger;
+        where?: Where;
+        queryTexts?: string | string[];
+        whereDocument?: WhereDocument;
+        include?: IncludeEnum[];
+    }): Promise<QueryResponse>;
+    /**
+     * Peek inside the collection
+     * @param {Object} params - The parameters for the query.
+     * @param {PositiveInteger} [params.limit] - Optional number of results to return (default is 10).
+     * @returns {Promise<GetResponse>} A promise that resolves to the query results.
+     * @throws {Error} If there is an issue executing the query.
+     *
+     * @example
+     * ```typescript
+     * const results = await collection.peek({
+     *   limit: 10
+     * });
+     * ```
+     */
+    peek({ limit }?: {
+        limit?: PositiveInteger;
+    }): Promise<GetResponse>;
+    /**
+     * Deletes items from the collection.
+     * @param {Object} params - The parameters for deleting items from the collection.
+     * @param {ID | IDs} [params.ids] - Optional ID or array of IDs of items to delete.
+     * @param {Where} [params.where] - Optional query condition to filter items to delete based on metadata values.
+     * @param {WhereDocument} [params.whereDocument] - Optional query condition to filter items to delete based on document content.
+     * @returns {Promise<string[]>} A promise that resolves to the IDs of the deleted items.
+     * @throws {Error} If there is an issue deleting items from the collection.
+     *
+     * @example
+     * ```typescript
+     * const results = await collection.delete({
+     *   ids: "some_id",
+     *   where: {"name": {"$eq": "John Doe"}},
+     *   whereDocument: {"$contains":"search_string"}
+     * });
+     * ```
+     */
+    delete({ ids, where, whereDocument }?: {
+        ids?: ID | IDs;
+        where?: Where;
+        whereDocument?: WhereDocument;
+    }): Promise<string[]>;
+}
+//# sourceMappingURL=Collection.d.ts.map

package/dist/main/Collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../../src/Collection.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,WAAW,EACX,QAAQ,EACR,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EACR,SAAS,EACT,KAAK,EACL,aAAa,EACb,EAAE,EACF,GAAG,EACH,eAAe,EACf,WAAW,EACX,aAAa,EACb,WAAW,EACX,kBAAkB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AAKnD,qBAAa,UAAU;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,OAAO,CAAC,GAAG,CAAa;IACxB;;OAEG;IACI,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAEzD;;OAEG;gBAEC,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,GAAG,EAAE,UAAU,EACf,QAAQ,CAAC,EAAE,kBAAkB,EAC7B,iBAAiB,CAAC,EAAE,kBAAkB;IAU1C;;OAEG;IACH,OAAO,CAAC,OAAO;IAGf;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;YACW,QAAQ;IA+EtB;;;;;;;;;;;;;;;;;;OAkBG;IACU,GAAG,CAAC,EACb,GAAG,EACH,UAAU,EACV,SAAS,EACT,SAAS,GACZ,EAAE;QACC,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC;QACd,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QACpC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACjC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;KACpC,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBxB;;;;;;;;;;;;;;;;;;OAkBG;IACU,MAAM,CAAC,EAChB,GAAG,EACH,UAAU,EACV,SAAS,EACT,SAAS,GACZ,EAAE;QACC,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC;QACd,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QACpC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACjC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;KACpC,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BpB;;;;;;;;OAQG;IACU,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAKrC;;;;;;;;;;;;;;OAcG;IACU,MAAM,CAAC,EAChB,IAAI,EACJ,QAAQ,EACX,GAAE;QACC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,kBAAkB,CAAA;KAC3B,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,GAAG,CAAC,EACb,GAAG,EACH,KAAK,EACL,KAAK,EACL,MAAM,EACN,OAAO,EACP,aAAa,GAChB,GAAE;QACC,GAAG,CAAC,EAAE,EAAE,GAAG,GAAG,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,eAAe,CAAC;QACxB,MAAM,CAAC,EAAE,eAAe,CAAC;QACzB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QACxB,aAAa,CAAC,EAAE,aAAa,CAAA;KAC3B,GAAG,OAAO,CAAC,WAAW,CAAC;IAiB7B;;;;;;;;;;;;;;;;;;OAkBG;IACU,MAAM,CAAC,EAChB,GAAG,EACH,UAAU,EACV,SAAS,EACT,SAAS,GACZ,EAAE;QACC,GAAG,EAAE,EAAE,GAAG,GAAG,CAAC;QACd,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QACpC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QACjC,SAAS,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;KACpC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwCpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,KAAK,CAAC,EACf,eAAe,EACf,QAAQ,EACR,KAAK,EACL,UAAU,EACV,aAAa,EACb,OAAO,GACV,EAAE;QACC,eAAe,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QACzC,QAAQ,CAAC,EAAE,eAAe,CAAC;QAC3B,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC/B,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;KAC1B,GAAG,OAAO,CAAC,aAAa,CAAC;IAiC1B;;;;;;;;;;;;;OAaG;IACU,IAAI,CAAC,EAAE,KAAK,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,eAAe,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAQpF;;;;;;;;;;;;;;;;;OAiBG;IACU,MAAM,CAAC,EAChB,GAAG,EACH,KAAK,EACL,aAAa,EAChB,GAAE;QACC,GAAG,CAAC,EAAE,EAAE,GAAG,GAAG,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,aAAa,CAAC,EAAE,aAAa,CAAA;KAC3B,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAQ7B"}