Share via


VectorStores.CancelVectorStoreFileBatch Method

Definition

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

public virtual Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch> CancelVectorStoreFileBatch(string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelVectorStoreFileBatch : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>
override this.CancelVectorStoreFileBatch : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Agents.Persistent.VectorStoreFileBatch>
Public Overridable Function CancelVectorStoreFileBatch (vectorStoreId As String, batchId As String, Optional cancellationToken As CancellationToken = Nothing) As 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.

Applies to