FirestoreVectorStore

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:92

Extends

• BaseVectorStore<Firestore>

Constructors

new FirestoreVectorStore()

new FirestoreVectorStore(__namedParameters): FirestoreVectorStore

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:107

Parameters

__namedParameters

FirestoreParams

Returns

FirestoreVectorStore

Overrides

BaseVectorStore<Firestore>.constructor

Properties

storesText

storesText: boolean = true

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:93

Overrides

BaseVectorStore.storesText

---

isEmbeddingQuery?

optional isEmbeddingQuery: boolean = false

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:94

Overrides

BaseVectorStore.isEmbeddingQuery

---

flatMetadata

flatMetadata: boolean = true

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:95

Methods

client()

client(): Firestore

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:145

Returns

Firestore

Overrides

BaseVectorStore.client

---

add()

add(nodes): Promise<string[]>

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:154

Adds nodes to the vector store

Parameters

nodes

BaseNode<Metadata>[]

Array of nodes to add to the vector store

Returns

Promise<string[]>

Array of node IDs that were added

Overrides

BaseVectorStore.add

---

delete()

delete(fileName): Promise<void>

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:198

Deletes all nodes from the vector store that match the given filename

Parameters

fileName

string

Name of the file whose nodes should be deleted

Returns

Promise<void>

Overrides

BaseVectorStore.delete

---

query()

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

Defined in: providers/storage/firestore/src/FirestoreVectorStore.ts:220

Queries the vector store for similar nodes

Parameters

query

VectorStoreQuery

Query parameters including queryStr or queryEmbedding, filters, and similarityTopK

_options?

object

Optional parameters for the query

Returns

Promise<VectorStoreQueryResult>

Query results containing matching nodes, their similarities, and IDs

Throws

When neither queryEmbedding nor queryStr is provided

Overrides

BaseVectorStore.query