Class ChromaStore

constructor

• new ChromaStore(options?: ChromaStoreOptions): ChromaStore

  Parameters

  • options: ChromaStoreOptions = {}

  Returns ChromaStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): ChromaClientLike

  Returns the underlying ChromaClient for anything not wrapped here.

  Returns ChromaClientLike

createCollection

• createCollection(
      name: string,
      options?: CollectionOptions,
  ): Promise<ChromaCollectionLike>

  Create a new collection. Fails if a collection with name already exists.

  Parameters

  • name: string
  • options: CollectionOptions = {}

  Returns Promise<ChromaCollectionLike>

getOrCreateCollection

• getOrCreateCollection(
      name: string,
      options?: CollectionOptions,
  ): Promise<ChromaCollectionLike>

  Get an existing collection, creating it if it doesn't exist. Idempotent.

  Parameters

  • name: string
  • options: CollectionOptions = {}

  Returns Promise<ChromaCollectionLike>

deleteCollection

• deleteCollection(name: string): Promise<unknown>

  Delete a collection and all of its embeddings.

  Parameters

  • name: string

  Returns Promise<unknown>

addEmbeddings

• addEmbeddings(collection: string, params: AddEmbeddingsParams): Promise<unknown>

  Add embeddings to a collection. ids/embeddings (and optional metadatas/documents) are index-aligned parallel arrays - the i-th id/embedding/metadata/document all describe the same record.

  Parameters

  • collection: string
  • params: AddEmbeddingsParams

  Returns Promise<unknown>

query

• query(collection: string, params: QueryEmbeddingsParams): Promise<unknown>

  Find, for each query embedding, the nResults closest records in a collection (optionally narrowed by a metadata where filter). Returns the driver's raw response ({ ids, distances, metadatas, documents, ... }, each an array-per-query-embedding).

  Parameters

  • collection: string
  • params: QueryEmbeddingsParams

  Returns Promise<unknown>

get

• get(collection: string, params: GetEmbeddingsParams): Promise<unknown>

  Fetch records by id (and/or a metadata where filter) from a collection.

  Parameters

  • collection: string
  • params: GetEmbeddingsParams

  Returns Promise<unknown>

deleteEmbeddings

• deleteEmbeddings(
      collection: string,
      params: DeleteEmbeddingsParams,
  ): Promise<unknown>

  Delete records from a collection by id (and/or a metadata where filter).

  Parameters

  • collection: string
  • params: DeleteEmbeddingsParams

  Returns Promise<unknown>