Skip to main content

Class: ChromaVectorStore

Implements

Constructors

constructor

new ChromaVectorStore(init): ChromaVectorStore

Parameters

NameType
initObject
init.chromaClientParams?ChromaClientParams
init.collectionNamestring
init.textKey?string

Returns

ChromaVectorStore

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:39

Properties

chromaClient

Private chromaClient: ChromaClient

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:35


collection

Private collection: null | Collection = null

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:36


collectionName

Private collectionName: string

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:37


flatMetadata

flatMetadata: boolean = true

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:33


storesText

storesText: boolean = true

Implementation of

VectorStore.storesText

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:32


textKey

textKey: string

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:34

Methods

add

add(nodes): Promise<string[]>

Parameters

NameType
nodesBaseNode<Metadata>[]

Returns

Promise<string[]>

Implementation of

VectorStore.add

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:75


client

client(): ChromaClient

Returns

ChromaClient

Implementation of

VectorStore.client

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:49


delete

delete(refDocId, deleteOptions?): Promise<void>

Parameters

NameType
refDocIdstring
deleteOptions?ChromaDeleteOptions

Returns

Promise<void>

Implementation of

VectorStore.delete

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:86


getCollection

getCollection(): Promise<Collection>

Returns

Promise<Collection>

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:53


getDataToInsert

getDataToInsert(nodes): AddParams

Parameters

NameType
nodesBaseNode<Metadata>[]

Returns

AddParams

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:63


query

query(query, options?): Promise<VectorStoreQueryResult>

Parameters

NameType
queryVectorStoreQuery
options?ChromaQueryOptions

Returns

Promise<VectorStoreQueryResult>

Implementation of

VectorStore.query

Defined in

packages/core/src/storage/vectorStore/ChromaVectorStore.ts:98