VolatileMemoryStore Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A simple volatile memory embeddings store.
public class VolatileMemoryStore : Microsoft.SemanticKernel.Memory.IMemoryStoretype VolatileMemoryStore = class
interface IMemoryStorePublic Class VolatileMemoryStore
Implements IMemoryStore- Inheritance
-
VolatileMemoryStore
- Implements
Constructors
| VolatileMemoryStore() |
Methods
| CreateCollectionAsync(String, CancellationToken) |
Creates a new collection in the data store. |
| DeleteCollectionAsync(String, CancellationToken) |
Deletes a collection from the data store. |
| 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) |
Retrieves the nearest matches to the given embedding in the specified collection. |
| 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. |
| TryGetCollection(String, ConcurrentDictionary<String,MemoryRecord>, Boolean) |
Tries to get the collection with the specified name. |
| 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. |