Share via

AzureCosmosDBMongoDBMemoryStore Class

  • Reference

Definition

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

An implementation of IMemoryStore backed by a Azure CosmosDB Mongo vCore database. Get more details about Azure Cosmos Mongo vCore vector search https://zcusa.951200.xyz/en-us/azure/cosmos-db/mongodb/vcore/vector-search

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

Constructors

AzureCosmosDBMongoDBMemoryStore(MongoClient, String, AzureCosmosDBMongoDBConfig)

Initiates a AzureCosmosDBMongoDBMemoryStore instance using a Azure CosmosDB MongoDB client and other properties required for vector search.
AzureCosmosDBMongoDBMemoryStore(String, String, AzureCosmosDBMongoDBConfig)

Initiates a AzureCosmosDBMongoDBMemoryStore instance using a Azure CosmosDB Mongo vCore 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 AzureCosmosDBMongoDBMemoryStore instance.
Dispose(Boolean)

Disposes the resources used by the AzureCosmosDBMongoDBMemoryStore 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