Class: AstraDBVectorStore
Extends
Implements
Constructors
new AstraDBVectorStore()
new AstraDBVectorStore(
init?):AstraDBVectorStore
Parameters
• init?: Partial<AstraDBVectorStore> & object & Partial<IEmbedModel>
Returns
Overrides
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:28
Properties
contentKey
contentKey:
string
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:22
embedModel
embedModel:
BaseEmbedding
Inherited from
Defined in
packages/llamaindex/src/storage/vectorStore/types.ts:103
flatMetadata
flatMetadata:
boolean=true
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:19
idKey
idKey:
string
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:21
storesText
storesText:
boolean=true
Implementation of
VectorStoreNoEmbedModel.storesText
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:18
Methods
add()
add(
nodes):Promise<string[]>
Add your document(s) to your Astra DB collection.
Parameters
Returns
Promise<string[]>
and array of node ids which were added
Implementation of
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:107
client()
client():
DataAPIClient
Get an instance of your Astra DB client.
Returns
DataAPIClient
the AstraDB client
Implementation of
VectorStoreNoEmbedModel.client
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:98
connect()
connect(
collection):Promise<void>
Connect to an existing collection in your Astra DB vector database.
You must call this method or createAndConnect before adding, deleting, or querying.
Parameters
• collection: string
Returns
Promise<void>
Promise that resolves if the connection did not throw an error.
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:87
createAndConnect()
createAndConnect(
collection,options?):Promise<void>
Create a new collection in your Astra DB vector database and connects to it.
You must call this method or connect before adding, deleting, or querying.
Parameters
• collection: string
• options?: CreateCollectionOptions<SomeDoc>
Returns
Promise<void>
Promise that resolves if the creation did not throw an error.
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:70
delete()
delete(
refDocId,deleteOptions?):Promise<void>
Delete a document from your Astra DB collection.
Parameters
• refDocId: string
• deleteOptions?: DeleteOneOptions
Returns
Promise<void>
Promise that resolves if the delete query did not throw an error.
Implementation of
VectorStoreNoEmbedModel.delete
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:147
query()
query(
query,options?):Promise<VectorStoreQueryResult>
Query documents from your Astra DB collection to get the closest match to your embedding.
Parameters
• query: VectorStoreQuery
• options?: FindOptions
Returns
Promise<VectorStoreQueryResult>
Implementation of
Defined in
packages/llamaindex/src/storage/vectorStore/AstraDBVectorStore.ts:172