Class: AstraDBVectorStore

Implements

• VectorStore

Constructors

constructor

• new AstraDBVectorStore(init?)

Parameters

Name	Type
init?	Partial<AstraDBVectorStore> & { params?: { dbId: string ; keyspace: string ; region: string ; token: string } }

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:19

Properties

astraDBClient

• astraDBClient: AstraDB

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:12

---

collection

• Private collection: undefined | Collection

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:17

---

contentKey

• contentKey: undefined | string

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:14

---

flatMetadata

• flatMetadata: boolean = true

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:10

---

idKey

• idKey: string

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:13

---

metadataKey

• metadataKey: string

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:15

---

storesText

• storesText: boolean = true

Implementation of

VectorStore.storesText

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:9

Methods

add

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

Add your document(s) to your Astra DB collection.

Parameters

Name	Type
nodes	BaseNode<Metadata>[]

Returns

Promise<string[]>

and array of node ids which were added

Implementation of

VectorStore.add

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:100

---

client

▸ client(): AstraDB

Get an instance of your Astra DB client.

Returns

AstraDB

the AstraDB client

Implementation of

VectorStore.client

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:91

---

connect

▸ connect(collection): Promise<void>

Connect to an existing collection in your Astra DB vector database. You must call this before adding, deleting, or querying.

Parameters

Name	Type	Description
collection	string	your existing colletion's name

Returns

Promise<void>

Promise that resolves if the connection did not throw an error.

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:80

---

create

▸ create(collection, options): Promise<void>

Create a new collection in your Astra DB vector database. You must still use connect() to connect to the collection.

Parameters

Name	Type	Description
collection	string	your new colletion's name
options	any	-

Returns

Promise<void>

Promise that resolves if the creation did not throw an error.

TODO

align options type with the JSON API's expected format

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:66

---

delete

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

Delete a document from your Astra DB collection.

Parameters

Name	Type	Description
refDocId	string	the id of the document to delete
deleteOptions?	any	-

Returns

Promise<void>

Promise that resolves if the delete query did not throw an error.

Implementation of

VectorStore.delete

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:143

---

query

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

Query documents from your Astra DB collection to get the closest match to your embedding.

Parameters

Name	Type
query	VectorStoreQuery
options?	any

Returns

Promise<VectorStoreQueryResult>

Implementation of

VectorStore.query

Defined in

packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:165