Class Chroma

The main class that extends the VectorStore class. It provides methods for interacting with the Chroma database, such as adding documents, deleting documents, and searching for similar vectors.

Hierarchy

VectorStore
- Chroma

Constructors

constructor

new Chroma(embeddings, args): Chroma
Parameters
- embeddings: Embeddings
- args: ChromaLibArgs
Returns Chroma
Overrides VectorStore.constructor
- Defined in langchain/src/vectorstores/chroma.ts:70

Properties

FilterType

FilterType: Where

collectionName

collectionName: string

embeddings

embeddings: Embeddings

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

url

url: string

`Optional` collection

collection?: Collection

`Optional` collectionMetadata

collectionMetadata?: CollectionMetadata

`Optional` filter

filter?: object

`Optional` index

index?: ChromaClient

`Optional` numDimensions

numDimensions?: number

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from VectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from VectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides VectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/chroma.ts:66

addDocuments

addDocuments(documents, options?): Promise<string[]>
Adds documents to the Chroma database. The documents are first converted to vectors using the embeddings instance, and then added to the database.
Parameters
- documents: Document<Record<string, any>>[]
  
  An array of Document instances to be added to the database.
- Optional options: {
  ids?: string[];
  }
  
  Optional. An object containing an array of ids for the documents.
  - Optional ids?: string[]
Returns Promise<string[]>
A promise that resolves when the documents have been added to the database.
Overrides VectorStore.addDocuments
- Defined in langchain/src/vectorstores/chroma.ts:93

addVectors

addVectors(vectors, documents, options?): Promise<string[]>
Adds vectors to the Chroma database. The vectors are associated with the provided documents.
Parameters
- vectors: number[][]
  
  An array of vectors to be added to the database.
- documents: Document<Record<string, any>>[]
  
  An array of Document instances associated with the vectors.
- Optional options: {
  ids?: string[];
  }
  
  Optional. An object containing an array of ids for the vectors.
  - Optional ids?: string[]
Returns Promise<string[]>
A promise that resolves with an array of document IDs when the vectors have been added to the database.
Overrides VectorStore.addVectors
- Defined in langchain/src/vectorstores/chroma.ts:134

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<Chroma>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Chroma>>
- Optional filter: Where
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<Chroma>
Inherited from VectorStore.asRetriever
- Defined in langchain/src/vectorstores/base.ts:246

delete

delete(params): Promise<void>
Deletes documents from the Chroma database. The documents to be deleted can be specified by providing an array of ids or a filter object.
Parameters
- params: ChromaDeleteParams<Where>
  
  An object containing either an array of ids of the documents to be deleted or a filter object to specify the documents to be deleted.
Returns Promise<void>
A promise that resolves when the specified documents have been deleted from the database.
Overrides VectorStore.delete
- Defined in langchain/src/vectorstores/chroma.ts:194

ensureCollection

ensureCollection(): Promise<Collection>
Ensures that a collection exists in the Chroma database. If the collection does not exist, it is created.

Returns Promise<Collection>
A promise that resolves with the Collection instance.
- Defined in langchain/src/vectorstores/chroma.ts:107

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Where = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in langchain/src/vectorstores/base.ts:174

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>
Searches for vectors in the Chroma database that are similar to the provided query vector. The search can be filtered using the provided filter object or the filter property of the Chroma instance.
Parameters
- query: number[]
  
  The query vector.
- k: number
  
  The number of similar vectors to return.
- Optional filter: Where
  
  Optional. A filter object to filter the search results.
Returns Promise<[Document<Record<string, any>>, number][]>
A promise that resolves with an array of tuples, each containing a Document instance and a similarity score.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in langchain/src/vectorstores/chroma.ts:216

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Where = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain/src/vectorstores/base.ts:189

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<Where>
- _callbacks: undefined | Callbacks
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain/src/vectorstores/base.ts:217

`Static` fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<Chroma>
Creates a new Chroma instance from an array of Document instances. The documents are added to the Chroma database.
Parameters
- docs: Document<Record<string, any>>[]
  
  An array of Document instances.
- embeddings: Embeddings
  
  An Embeddings instance used to generate embeddings for the documents.
- dbConfig: ChromaLibArgs
  
  A ChromaLibArgs object containing the configuration for the Chroma database.
Returns Promise<Chroma>
A promise that resolves with a new Chroma instance.
Overrides VectorStore.fromDocuments
- Defined in langchain/src/vectorstores/chroma.ts:312

`Static` fromExistingCollection

fromExistingCollection(embeddings, dbConfig): Promise<Chroma>
Creates a new Chroma instance from an existing collection in the Chroma database.
Parameters
- embeddings: Embeddings
  
  An Embeddings instance used to generate embeddings for the documents.
- dbConfig: ChromaLibArgs
  
  A ChromaLibArgs object containing the configuration for the Chroma database.
Returns Promise<Chroma>
A promise that resolves with a new Chroma instance.
- Defined in langchain/src/vectorstores/chroma.ts:329

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig): Promise<Chroma>
Creates a new Chroma instance from an array of text strings. The text strings are converted to Document instances and added to the Chroma database.
Parameters
- texts: string[]
  
  An array of text strings.
- metadatas: object | object[]
  
  An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the texts array.
- embeddings: Embeddings
  
  An Embeddings instance used to generate embeddings for the documents.
- dbConfig: ChromaLibArgs
  
  A ChromaLibArgs object containing the configuration for the Chroma database.
Returns Promise<Chroma>
A promise that resolves with a new Chroma instance.
Overrides VectorStore.fromTexts
- Defined in langchain/src/vectorstores/chroma.ts:286

`Static` imports

imports(): Promise<{
ChromaClient: typeof ChromaClient;
}>
Imports the ChromaClient from the chromadb module.

Returns Promise<{
ChromaClient: typeof ChromaClient;
}>
A promise that resolves with an object containing the ChromaClient constructor.
- Defined in langchain/src/vectorstores/chroma.ts:342

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from VectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class Chroma

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: ChromaLibArgs

Returns Chroma

Properties

FilterType

collectionName

embeddings

lc_kwargs

lc_namespace

lc_serializable

url

Optional collection

Optional collectionMetadata

Optional filter

Optional index

Optional numDimensions

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

_vectorstoreType

Returns string

addDocuments

Parameters

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Chroma>>

Optional filter: Where

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<Chroma>

delete

Parameters

params: ChromaDeleteParams<Where>

Returns Promise<void>

ensureCollection

Returns Promise<Collection>

similaritySearch

Parameters

query: string

k: number = 4

filter: undefined | Where = undefined

_callbacks: undefined | Callbacks = undefined

Returns Promise<Document<Record<string, any>>[]>

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

Optional filter: Where

Returns Promise<[Document<Record<string, any>>, number][]>

similaritySearchWithScore

`Optional` collection

`Optional` collectionMetadata

`Optional` filter

`Optional` index

`Optional` numDimensions

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<Chroma>>

`Optional` filter: Where

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

`Optional` filter: Where

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromExistingCollection

`Static` fromTexts

`Static` imports

Returns Promise<{
ChromaClient: typeof ChromaClient;
}>

`Static` lc_name