Share via

AzureCosmosDBNoSQLMemoryStore Class

  • Reference

Definition

Namespace:
Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL
Assembly:
Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL.dll
Package:
Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL v1.20.0-alpha

An implementation of IMemoryStore backed by a Azure Cosmos DB database. Get more details about Azure Cosmos DB vector search https://learn.microsoft.com/en-us/azure/cosmos-db/

public class AzureCosmosDBNoSQLMemoryStore : IDisposable, Microsoft.SemanticKernel.Memory.IMemoryStore
type AzureCosmosDBNoSQLMemoryStore = class
    interface IMemoryStore
    interface IDisposable
Public Class AzureCosmosDBNoSQLMemoryStore
Implements IDisposable, IMemoryStore
Inheritance
Object
AzureCosmosDBNoSQLMemoryStore
Implements
IMemoryStore IDisposable

Constructors

AzureCosmosDBNoSQLMemoryStore(CosmosClient, String, VectorEmbeddingPolicy, IndexingPolicy)

Initiates a AzureCosmosDBNoSQLMemoryStore instance using a CosmosClient instance and other properties required for vector search.
AzureCosmosDBNoSQLMemoryStore(String, String, UInt64, VectorDataType, VectorIndexType, String)

Initiates a AzureCosmosDBNoSQLMemoryStore instance using a Azure Cosmos DB connection string and other properties required for vector search.
AzureCosmosDBNoSQLMemoryStore(String, String, VectorEmbeddingPolicy, IndexingPolicy, String)

Initiates a AzureCosmosDBNoSQLMemoryStore instance using a Azure Cosmos DB connection string and other properties required for vector search.

Methods

CreateCollectionAsync(String, CancellationToken)

Creates a new collection in the data store.
DeleteCollectionAsync(String, CancellationToken)

Deletes a collection from the data store.
Dispose()

Disposes the AzureCosmosDBNoSQLMemoryStore instance.
Dispose(Boolean)

Disposes the resources used by the AzureCosmosDBNoSQLMemoryStore instance.
DoesCollectionExistAsync(String, CancellationToken)

Determines if a collection exists in the data store.
GetAsync(String, String, Boolean, CancellationToken)

Gets a memory record from the data store. Does not guarantee that the collection exists.
GetBatchAsync(String, IEnumerable<String>, Boolean, CancellationToken)

Gets a batch of memory records from the data store. Does not guarantee that the collection exists.
GetCollectionsAsync(CancellationToken)

Gets all collection names in the data store.
GetNearestMatchAsync(String, ReadOnlyMemory<Single>, Double, Boolean, CancellationToken)

Gets the nearest match to an embedding of type Single. Does not guarantee that the collection exists.
GetNearestMatchesAsync(String, ReadOnlyMemory<Single>, Int32, Double, Boolean, CancellationToken)

Gets the nearest matches to an embedding of type Single. Does not guarantee that the collection exists.
RemoveAsync(String, String, CancellationToken)

Removes a memory record from the data store. Does not guarantee that the collection exists.
RemoveBatchAsync(String, IEnumerable<String>, CancellationToken)

Removes a batch of memory records from the data store. Does not guarantee that the collection exists.
UpsertAsync(String, MemoryRecord, CancellationToken)

Upserts a memory record into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.
UpsertBatchAsync(String, IEnumerable<MemoryRecord>, CancellationToken)

Upserts a group of memory records into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.

Applies to