Partager via


AzureCosmosDBMongoDBVectorStoreRecordCollection<TRecord>.DeleteBatchAsync Method

Definition

Deletes a batch of records from the vector store. Does not guarantee that the collection exists. Deletes will be made in a single request or in a single parallel batch depending on the available store functionality. If a record is not found, it will be ignored and the batch will succeed. If any record cannot be deleted for any other reason, the operation will throw. Some records may have already been deleted, while others may not, so the entire operation should be retried.

public System.Threading.Tasks.Task DeleteBatchAsync (System.Collections.Generic.IEnumerable<string> keys, Microsoft.SemanticKernel.Data.DeleteRecordOptions? options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteBatchAsync : seq<string> * Microsoft.SemanticKernel.Data.DeleteRecordOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteBatchAsync : seq<string> * Microsoft.SemanticKernel.Data.DeleteRecordOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteBatchAsync (keys As IEnumerable(Of String), Optional options As DeleteRecordOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

keys
IEnumerable<String>

The unique ids associated with the records to remove.

options
DeleteRecordOptions

Optional options for removing the records.

cancellationToken
CancellationToken

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

Returns

A Task that completes when the records have been deleted.

Implements

Applies to