FirestoreVectorStore
Defined in: .build/typescript/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: .build/typescript/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”BaseVectorStore<Firestore>.constructor
Properties
Section titled “Properties”storesText
Section titled “storesText”storesText:
boolean=true
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:93
Overrides
Section titled “Overrides”BaseVectorStore.storesText
isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean=false
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:94
Overrides
Section titled “Overrides”BaseVectorStore.isEmbeddingQuery
flatMetadata
Section titled “flatMetadata”flatMetadata:
boolean=true
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:95
Methods
Section titled “Methods”client()
Section titled “client()”client():
Firestore
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:145
Returns
Section titled “Returns”Firestore
Overrides
Section titled “Overrides”BaseVectorStore.client
add(
nodes):Promise<string[]>
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:154
Adds nodes to the vector store
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
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”BaseVectorStore.add
delete()
Section titled “delete()”delete(
fileName):Promise<void>
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:198
Deletes all nodes from the vector store that match the given filename
Parameters
Section titled “Parameters”fileName
Section titled “fileName”string
Name of the file whose nodes should be deleted
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseVectorStore.delete
query()
Section titled “query()”query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: .build/typescript/packages/providers/storage/firestore/src/FirestoreVectorStore.ts:220
Queries the vector store for similar nodes
Parameters
Section titled “Parameters”VectorStoreQuery
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”BaseVectorStore.query