VolatileMemoryStore.RemoveAsync(String, String, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Memory

Assembly:: Microsoft.SemanticKernel.Plugins.Memory.dll

Package:: Microsoft.SemanticKernel.Plugins.Memory v1.20.0-alpha

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.

Removes a memory record from the data store. Does not guarantee that the collection exists.

public System.Threading.Tasks.Task RemoveAsync (string collectionName, string key, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RemoveAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function RemoveAsync (collectionName As String, key As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

collectionName: String

The name associated with a collection of embeddings.

key: String

The unique id associated with the memory record to remove.

cancellationToken: CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

Returns

Task

Implements

RemoveAsync(String, String, CancellationToken)

Applies to

Share via