AgentsClient.CancelVectorStoreFileBatch Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

CancelVectorStoreFileBatch(String, String, CancellationToken)	Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
CancelVectorStoreFileBatch(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 CancelVectorStoreFileBatch(String, String, CancellationToken) convenience overload with strongly typed models first.

CancelVectorStoreFileBatch(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 Azure.Response<Azure.AI.Projects.VectorStoreFileBatch> CancelVectorStoreFileBatch (string vectorStoreId, string batchId, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelVectorStoreFileBatch : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.VectorStoreFileBatch>
override this.CancelVectorStoreFileBatch : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.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

Response<VectorStoreFileBatch>

Exceptions

ArgumentNullException

vectorStoreId or batchId is null.

ArgumentException

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

CancelVectorStoreFileBatch(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 CancelVectorStoreFileBatch(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response CancelVectorStoreFileBatch (string vectorStoreId, string batchId, Azure.RequestContext context);

abstract member CancelVectorStoreFileBatch : string * string * Azure.RequestContext -> Azure.Response
override this.CancelVectorStoreFileBatch : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function CancelVectorStoreFileBatch (vectorStoreId As String, batchId As String, context As RequestContext) As 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

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.