Class: Chroma

vectorstores/chroma.Chroma

Hierarchy

• VectorStore

  ↳ Chroma

Constructors

constructor

• new Chroma(embeddings, args)

Parameters

Name	Type
embeddings	Embeddings
args	ChromaLibArgs

Overrides

VectorStore.constructor

Defined in

langchain/src/vectorstores/chroma.ts:24

Properties

collectionName

• collectionName: string

Defined in

langchain/src/vectorstores/chroma.ts:18

---

embeddings

• embeddings: Embeddings

Inherited from

VectorStore.embeddings

Defined in

langchain/src/vectorstores/base.ts:23

---

index

• Optional index: ChromaClient

Defined in

langchain/src/vectorstores/chroma.ts:16

---

numDimensions

• Optional numDimensions: number

Defined in

langchain/src/vectorstores/chroma.ts:20

---

url

• url: string

Defined in

langchain/src/vectorstores/chroma.ts:22

Methods

addDocuments

▸ addDocuments(documents): Promise<void>

Parameters

Name	Type
documents	Document<Record<string, any>>[]

Returns

Promise<void>

Overrides

VectorStore.addDocuments

Defined in

langchain/src/vectorstores/chroma.ts:33

---

addVectors

▸ addVectors(vectors, documents): Promise<void>

Parameters

Name	Type
vectors	number[][]
documents	Document<Record<string, any>>[]

Returns

Promise<void>

Overrides

VectorStore.addVectors

Defined in

langchain/src/vectorstores/chroma.ts:53

---

asRetriever

▸ asRetriever(k?): BaseRetriever

Parameters

Name	Type
k?	number

Returns

BaseRetriever

Inherited from

VectorStore.asRetriever

Defined in

langchain/src/vectorstores/base.ts:92

---

ensureCollection

▸ ensureCollection(): Promise<void>

Returns

Promise<void>

Defined in

langchain/src/vectorstores/chroma.ts:41

---

similaritySearch

▸ similaritySearch(query, k?, filter?): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

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

Inherited from

VectorStore.similaritySearch

Defined in

langchain/src/vectorstores/base.ts:43

---

similaritySearchVectorWithScore

▸ similaritySearchVectorWithScore(query, k): Promise<[Document<Record<string, any>>, number][]>

Parameters

Name	Type
query	number[]
k	number

Returns

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

Overrides

VectorStore.similaritySearchVectorWithScore

Defined in

langchain/src/vectorstores/chroma.ts:90

---

similaritySearchWithScore

▸ similaritySearchWithScore(query, k?, filter?): Promise<[object, number][]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

Promise<[object, number][]>

Inherited from

VectorStore.similaritySearchWithScore

Defined in

langchain/src/vectorstores/base.ts:57

---

fromDocuments

▸ Static fromDocuments(docs, embeddings, dbConfig): Promise<Chroma>

Parameters

Name	Type
docs	Document<Record<string, any>>[]
embeddings	Embeddings
dbConfig	Object
dbConfig.collectionName?	string
dbConfig.url?	string

Returns

Promise<Chroma>

Overrides

VectorStore.fromDocuments

Defined in

langchain/src/vectorstores/chroma.ts:143

---

fromExistingCollection

▸ Static fromExistingCollection(embeddings, dbConfig): Promise<Chroma>

Parameters

Name	Type
embeddings	Embeddings
dbConfig	Object
dbConfig.collectionName	string
dbConfig.url?	string

Returns

Promise<Chroma>

Defined in

langchain/src/vectorstores/chroma.ts:156

---

fromTexts

▸ Static fromTexts(texts, metadatas, embeddings, dbConfig): Promise<Chroma>

Parameters

Name	Type
texts	string[]
metadatas	object | object[]
embeddings	Embeddings
dbConfig	Object
dbConfig.collectionName?	string
dbConfig.url?	string

Returns

Promise<Chroma>

Overrides

VectorStore.fromTexts

Defined in

langchain/src/vectorstores/chroma.ts:122

---

imports

▸ Static imports(): Promise<{ ChromaClient: typeof ChromaClient }>

Returns

Promise<{ ChromaClient: typeof ChromaClient }>

Defined in

langchain/src/vectorstores/chroma.ts:168