Class: AstraDBVectorStore
Implements
Constructors
constructor
• new AstraDBVectorStore(init?
): AstraDBVectorStore
Parameters
Name | Type |
---|---|
init? | Partial <AstraDBVectorStore > & { params? : { endpoint : string ; namespace : string ; token : string } } |
Returns
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:26
Properties
astraDBClient
• astraDBClient: AstraDB
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:19
collection
• Private
collection: undefined
| Collection
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:24
contentKey
• contentKey: string
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:21
flatMetadata
• flatMetadata: boolean
= true
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:17
idKey
• idKey: string
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:20
metadataKey
• metadataKey: string
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:22
storesText
• storesText: boolean
= true
Implementation of
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:16
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
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:106
client
▸ client(): AstraDB
Get an instance of your Astra DB client.
Returns
AstraDB
the AstraDB client
Implementation of
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:97
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:86
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? | _CreateCollectionOptions | - |
Returns
Promise
<void
>
Promise that resolves if the creation did not throw an error.
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:69
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
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:156
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
Defined in
packages/core/src/storage/vectorStore/AstraDBVectorStore.ts:178