IPineconeClient.DeleteAsync Method
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.
Delete
public System.Threading.Tasks.Task DeleteAsync (string indexName, System.Collections.Generic.IEnumerable<string>? ids = default, string indexNamespace = "", System.Collections.Generic.Dictionary<string,object>? filter = default, bool deleteAll = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : string * seq<string> * string * System.Collections.Generic.Dictionary<string, obj> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DeleteAsync (indexName As String, Optional ids As IEnumerable(Of String) = Nothing, Optional indexNamespace As String = "", Optional filter As Dictionary(Of String, Object) = Nothing, Optional deleteAll As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
- indexName
- String
The name of the index
- ids
- IEnumerable<String>
The ids to delete
- indexNamespace
- String
The namespace to use
- filter
- Dictionary<String,Object>
The filter to use
- deleteAll
- Boolean
Whether to delete all vectors
- cancellationToken
- CancellationToken
Cancellation Token to cancel the request.
Returns
Task of Object
Remarks
The Delete operation deletes vectors, by id, from a single namespace. It's possible to delete items by their id, from a single namespace.