Class: Collection

Properties#

• id: string
• metadata: CollectionMetadata
• name: string

Methods#

add

• add(params): Promise<void>

Add items to the collection

Parameters

Returns

Promise<void>

• The response from the API.

Example

const response = await collection.add({
  ids: ["id1", "id2"],
  embeddings: [
    [1, 2, 3],
    [4, 5, 6],
  ],
  metadatas: [{ key: "value" }, { key: "value" }],
  documents: ["document1", "document2"],
});

count

• count(): Promise<number>

Count the number of items in the collection

Returns

Promise<number>

• The number of items in the collection.

Example

const count = await collection.count();

delete

• delete(params?): Promise<void>

Deletes items from the collection.

Parameters

Returns

Promise<void>

A promise that resolves when the deletion is complete.

Throws

If there is an issue deleting items from the collection.

Example

const results = await collection.delete({
  ids: ["some_id"],
  where: { name: { $eq: "John Doe" } },
  whereDocument: { $contains: "search_string" },
});

get

• get(params?): Promise<GetResult>

Get items from the collection

Parameters

Returns

Promise<GetResult>

The response from the server.

Example

const response = await collection.get({
  ids: ["id1", "id2"],
  where: { key: "value" },
  limit: 10,
  offset: 0,
  include: ["embeddings", "metadatas", "documents"],
  whereDocument: { $contains: "value" },
});

modify

• modify(params): Promise<void>

Modify the collection name, metadata, or configuration

Parameters

Returns

Promise<void>

A promise that resolves when the modification is complete.

Example

await collection.modify({
  name: "new name",
  metadata: { key: "value" },
  configuration: {
    hnsw: {
      ef_search: 100,
      batch_size: 1000
    }
  }
});

peek

• peek(params?): Promise<GetResult>

Peek inside the collection

Parameters

Returns

Promise<GetResult>

A promise that resolves to the query results.

Throws

If there is an issue executing the query.

Example

const results = await collection.peek({
  limit: 10,
});

query

• query(params): Promise<QueryResult>

Performs a query on the collection using the specified parameters.

Parameters

Returns

Promise<QueryResult>

A promise that resolves to the query results.

Throws

If there is an issue executing the query.

Example

// Query the collection using embeddings
const embeddingsResults = await collection.query({
  queryEmbeddings: [[0.1, 0.2, ...], ...],
  ids: ["id1", "id2", ...],
  nResults: 10,
  where: {"name": {"$eq": "John Doe"}},
  include: ["metadatas", "documents"]
});

// Query the collection using query text
const textResults = await collection.query({
    queryTexts: ["some text"],
    ids: ["id1", "id2", ...],
    nResults: 10,
    where: {"name": {"$eq": "John Doe"}},
    include: ["metadatas", "documents"]
});

search

• search(searches): Promise<SearchResult>

Performs hybrid search on the collection using expression builders. This method provides a flexible, composable API for building complex search queries with filtering, ranking, and result selection.

Parameters

Returns

Promise<SearchResult>

A promise that resolves to search results in column-major format. Use the .rows() method to convert to row-major format.

Throws

If there is an issue executing the search or if no search payload is provided.

Example

import { Search, K, Knn, Rrf, Val } from "chromadb";

// Basic search with KNN ranking
const results = await collection.search(
  new Search()
    .where(K("category").eq("science"))
    .rank(Knn({ query: [0.1, 0.2, 0.3], limit: 10 }))
    .limit(5)
    .select(K.DOCUMENT, K.SCORE, "title")
);

update

• update(params): Promise<void>

Update items in the collection

Parameters

Returns

Promise<void>

Example

await collection.update({
  ids: ["id1", "id2"],
  embeddings: [
    [1, 2, 3],
    [4, 5, 6],
  ],
  metadatas: [{ key: "value" }, { key: "value" }],
  documents: ["document1", "document2"],
});

upsert

• upsert(params): Promise<void>

Upsert items to the collection (inserts new records or updates existing ones)

Parameters

Returns

Promise<void>

Example

await collection.upsert({
  ids: ["id1", "id2"],
  embeddings: [
    [1, 2, 3],
    [4, 5, 6],
  ],
  metadatas: [{ key: "value" }, { key: "value" }],
  documents: ["document1", "document2"],
});