LlamaIndexTS/apps/docs/docs/api/interfaces/VectorStore.md

id, title, sidebar_label, sidebar_position, custom_edit_url

id	title	sidebar_label	sidebar_position	custom_edit_url
VectorStore	Interface: VectorStore	VectorStore	0	null

Properties

isEmbeddingQuery

• Optional isEmbeddingQuery: boolean

Defined in

storage/vectorStore/types.ts:63

---

storesText

• storesText: boolean

Defined in

storage/vectorStore/types.ts:62

Methods

add

▸ add(embeddingResults): Promise<string[]>

Parameters

Name	Type
embeddingResults	NodeWithEmbedding[]

Returns

Promise<string[]>

Defined in

storage/vectorStore/types.ts:65

---

client

▸ client(): any

Returns

any

Defined in

storage/vectorStore/types.ts:64

---

delete

▸ delete(refDocId, deleteKwargs?): Promise<void>

Parameters

Name	Type
refDocId	string
deleteKwargs?	any

Returns

Promise<void>

Defined in

storage/vectorStore/types.ts:66

---

persist

▸ persist(persistPath, fs?): Promise<void>

Parameters

Name	Type
persistPath	string
fs?	GenericFileSystem

Returns

Promise<void>

Defined in

storage/vectorStore/types.ts:68

---

query

▸ query(query, kwargs?): Promise<VectorStoreQueryResult>

Parameters

Name	Type
query	VectorStoreQuery
kwargs?	any

Returns

Promise<VectorStoreQueryResult>

Defined in

storage/vectorStore/types.ts:67