AzureCosmosDBNoSqlVectorStore

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:131

Extends

• BaseVectorStore

Constructors

new AzureCosmosDBNoSqlVectorStore()

new AzureCosmosDBNoSqlVectorStore(dbConfig): AzureCosmosDBNoSqlVectorStore

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:174

Parameters

dbConfig

AzureCosmosDBNoSQLConfig & VectorStoreBaseParams

Returns

AzureCosmosDBNoSqlVectorStore

Overrides

BaseVectorStore.constructor

Properties

storesText

storesText: boolean = true

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:132

Overrides

BaseVectorStore.storesText

---

cosmosClient

cosmosClient: CosmosClient

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:141

The CosmosDB client. This is either passed in or created.

---

textKey

textKey: string

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:146

The key to use for the text field in the CosmosDB container. Default: "text"

---

flatMetadata

flatMetadata: boolean = true

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:148

---

idKey

idKey: string

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:154

The key to use for the id field in the CosmosDB container. Default: "id"

---

metadataKey

metadataKey: string

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:160

The key to use for the metadata field in the CosmosDB container. Default: "metadata"

---

embeddingKey

embeddingKey: string

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:166

The key to use for the vector embedding field in the CosmosDB container. Default: "embedding"

Methods

client()

client(): unknown

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:170

Returns

unknown

Overrides

BaseVectorStore.client

---

fromConnectionString()

static fromConnectionString(config): AzureCosmosDBNoSqlVectorStore

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:232

Static method for creating an instance using a connection string. If no connection string is provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_CONNECTION_STRING as connection string.

Parameters

config

object & AzureCosmosDBNoSQLConfig & VectorStoreBaseParams = {}

Returns

AzureCosmosDBNoSqlVectorStore

Instance of AzureCosmosDBNoSqlVectorStore

---

fromAccountAndKey()

static fromAccountAndKey(config): AzureCosmosDBNoSqlVectorStore

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:256

Static method for creating an instance using a account endpoint and key. If no endpoint and key is provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT as enpoint and AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY as key.

Parameters

config

object & AzureCosmosDBNoSQLConfig & VectorStoreBaseParams = {}

Returns

AzureCosmosDBNoSqlVectorStore

Instance of AzureCosmosDBNoSqlVectorStore

---

fromUriAndManagedIdentity()

static fromUriAndManagedIdentity(config): AzureCosmosDBNoSqlVectorStore

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:284

Static method for creating an instance using account endpoint and managed identity. If no endpoint and credentials are provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT as endpoint and use DefaultAzureCredential() as credentials.

Parameters

config

object & AzureCosmosDBNoSQLConfig & VectorStoreBaseParams = {}

Returns

AzureCosmosDBNoSqlVectorStore

Instance of AzureCosmosDBNoSqlVectorStore

---

add()

add(nodes): Promise<string[]>

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:310

Adds document to the CosmosDB container.

Parameters

nodes

BaseNode<Metadata>[]

Returns

Promise<string[]>

an array of document ids which were added

Overrides

BaseVectorStore.add

---

delete()

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

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:353

Delete a document from the CosmosDB container.

Parameters

refDocId

string

The id of the document to delete

deleteOptions?

object

Any options to pass to the container.item.delete function

Returns

Promise<void>

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

Overrides

BaseVectorStore.delete

---

query()

query(query, options): Promise<VectorStoreQueryResult>

Defined in: providers/storage/azure/src/vectorStore/AzureCosmosDBNoSqlVectorStore.ts:364

Performs a vector similarity search query in the CosmosDB container.

Parameters

query

VectorStoreQuery

VectorStoreQuery

options

AzureCosmosQueryOptions = {}

Returns

Promise<VectorStoreQueryResult>

List of nodes along with similarityScore

Overrides

BaseVectorStore.query