VectorStores.CancelVectorStoreFileBatchAsync 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.
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>> CancelVectorStoreFileBatchAsync(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default);abstract member CancelVectorStoreFileBatchAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>>
override this.CancelVectorStoreFileBatchAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>>Public Overridable Function CancelVectorStoreFileBatchAsync (vectorStoreId As String, batchId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VectorStoreFileBatch))Parameters
- vectorStoreId
- String
Identifier of the vector store.
- batchId
- String
Identifier of the file batch.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
vectorStoreId or batchId is null.
vectorStoreId or batchId is an empty string, and was expected to be non-empty.
