Class: AzureCosmosDBNoSqlVectorStore

Extends

• BaseVectorStore

Constructors

new AzureCosmosDBNoSqlVectorStore()

new AzureCosmosDBNoSqlVectorStore(azureCosmosNoSqlKVStore, dbConfig?, embedModel?): AzureCosmosDBNoSqlVectorStore

Parameters

• azureCosmosNoSqlKVStore: AzureCosmosNoSqlKVStore

• dbConfig?: AzureCosmosDBNoSQLConfig

• embedModel?: VectorStoreBaseParams

Returns

AzureCosmosDBNoSqlVectorStore

Overrides

BaseVectorStore.constructor

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:135

Properties

cosmosClient

cosmosClient: CosmosClient

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:94

---

embedModel

embedModel: BaseEmbedding

Inherited from

BaseVectorStore.embedModel

Defined in

packages/llamaindex/src/vector-store/types.ts:89

---

embeddingKey

embeddingKey: string

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:119

---

flatMetadata

flatMetadata: boolean = true

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:101

---

idKey

idKey: string

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:107

---

isEmbeddingQuery?

optional isEmbeddingQuery: boolean

Inherited from

BaseVectorStore.isEmbeddingQuery

Defined in

packages/llamaindex/src/vector-store/types.ts:91

---

kvStore

kvStore: AzureCosmosNoSqlKVStore

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:133

---

metadataKey

metadataKey: string

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:113

---

storesText

storesText: boolean = true

Overrides

BaseVectorStore.storesText

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:85

---

textKey

textKey: string

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:99

Methods

add()

add(nodes): Promise<string[]>

Adds document to the CosmosDB container.

Parameters

• nodes: BaseNode<Metadata>[]

Returns

Promise<string[]>

an array of document ids which were added

Overrides

BaseVectorStore.add

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:192

---

client()

client(): any

Returns

any

Overrides

BaseVectorStore.client

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:123

---

delete()

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

Delete a document from the CosmosDB container.

Parameters

• refDocId: string

The id of the document to delete

• deleteOptions?: any

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

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:235

---

query()

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

Performs a vector similarity search query in the CosmosDB container.

Parameters

• query: VectorStoreQuery

VectorStoreQuery

• options?: any

Returns

Promise<VectorStoreQueryResult>

List of nodes along with similarityScore

Overrides

BaseVectorStore.query

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:246

---

fromAadToken()

static fromAadToken(options?): AzureCosmosDBNoSqlVectorStore

Parameters

• options?: AadTokenOptions

Returns

AzureCosmosDBNoSqlVectorStore

Defined in

packages/llamaindex/src/vector-store/AzureCosmosDBNoSqlVectorStore.ts:127