IVectorStoreRecordCollection<TKey,TRecord>.DeleteAsync Method

Definition

Deletes a record from the vector store. Does not guarantee that the collection exists.

public System.Threading.Tasks.Task DeleteAsync (TKey key, Microsoft.SemanticKernel.Data.DeleteRecordOptions? options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : 'Key * Microsoft.SemanticKernel.Data.DeleteRecordOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteAsync (key As TKey, Optional options As DeleteRecordOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

key
TKey

The unique id associated with the record to remove.

options
DeleteRecordOptions

Optional options for removing the record.

cancellationToken
CancellationToken

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

Returns

The unique identifier for the record.

Exceptions

Throw when the command fails to execute for any reason other than that the record does not exit.

Applies to