FirestoreVectorStore
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:92
Extends
Section titled “Extends”BaseVectorStore<Firestore>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FirestoreVectorStore(
__namedParameters):FirestoreVectorStore
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:107
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”FirestoreParams
Returns
Section titled “Returns”FirestoreVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”embedModel
Section titled “embedModel”embedModel:
BaseEmbedding
Defined in: packages/core/src/vector-store/index.ts:128
Inherited from
Section titled “Inherited from”storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:93
Overrides
Section titled “Overrides”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean=false
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:94
Overrides
Section titled “Overrides”BaseVectorStore.isEmbeddingQuery
flatMetadata
Section titled “flatMetadata”flatMetadata:
boolean=true
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:95
Methods
Section titled “Methods”client()
Section titled “client()”client():
Firestore
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:145
Returns
Section titled “Returns”Firestore
Overrides
Section titled “Overrides”add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:154
Adds nodes to the vector store
Parameters
Section titled “Parameters”Array of nodes to add to the vector store
Returns
Section titled “Returns”Promise<string[]>
Array of node IDs that were added
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId):Promise<void>
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:198
Deletes all nodes from the vector store 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.
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:220
Queries the vector store for similar nodes
Parameters
Section titled “Parameters”Query parameters including queryStr or queryEmbedding, filters, and similarityTopK
_options?
Section titled “_options?”object
Optional parameters for the query
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Query results containing matching nodes, their similarities, and IDs
Throws
Section titled “Throws”When neither queryEmbedding nor queryStr is provided
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/firestore/src/FirestoreVectorStore.ts:274
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