AgentsClient.CancelVectorStoreFileBatchAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Overloads

CancelVectorStoreFileBatchAsync(String, String, RequestContext)	[Protocol Method] Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CancelVectorStoreFileBatchAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
CancelVectorStoreFileBatchAsync(String, String, CancellationToken)	Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

CancelVectorStoreFileBatchAsync(String, String, RequestContext)

Source:

AgentsClient.cs

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

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler CancelVectorStoreFileBatchAsync(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> CancelVectorStoreFileBatchAsync (string vectorStoreId, string batchId, Azure.RequestContext context);

abstract member CancelVectorStoreFileBatchAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelVectorStoreFileBatchAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CancelVectorStoreFileBatchAsync (vectorStoreId As String, batchId As String, context As RequestContext) As Task(Of Response)

Parameters

vectorStoreId

String

Identifier of the vector store.

batchId

String

Identifier of the file batch.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

vectorStoreId or batchId is null.

ArgumentException

vectorStoreId or batchId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

CancelVectorStoreFileBatchAsync(String, String, CancellationToken)

Source:

AgentsClient.cs

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.Projects.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.Projects.VectorStoreFileBatch>>
override this.CancelVectorStoreFileBatchAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.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

Task<Response<VectorStoreFileBatch>>

Exceptions

ArgumentNullException

vectorStoreId or batchId is null.

ArgumentException

vectorStoreId or batchId is an empty string, and was expected to be non-empty.