ChromaVectorStore
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:47
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChromaVectorStore(
init):ChromaVectorStore
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:55
Parameters
Section titled “Parameters”collectionName
Section titled “collectionName”string
textKey?
Section titled “textKey?”string
chromaClientParams?
Section titled “chromaClientParams?”ChromaClientParams
Returns
Section titled “Returns”ChromaVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:48
Overrides
Section titled “Overrides”flatMetadata
Section titled “flatMetadata”flatMetadata:
boolean=true
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:49
textKey
Section titled “textKey”textKey:
string
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:50
isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:120
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
Methods
Section titled “Methods”client()
Section titled “client()”client():
ChromaClient
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:66
Returns
Section titled “Returns”ChromaClient
Overrides
Section titled “Overrides”getCollection()
Section titled “getCollection()”getCollection():
Promise<Collection>
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:70
Returns
Section titled “Returns”Promise<Collection>
add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:92
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string[]>
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteOptions?):Promise<void>
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:108
Deletes all nodes from the collection that belong to the given document.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Reference document ID - all nodes with this ref_doc_id will be deleted.
deleteOptions?
Section titled “deleteOptions?”ChromaDeleteOptions
Optional delete parameters for Chroma.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:192
Parameters
Section titled “Parameters”options?
Section titled “options?”ChromaQueryOptions
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/chroma/src/ChromaVectorStore.ts:236
Check if any nodes exist for the given document reference ID. Used for de-duplication during ingestion.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist