IOpenAIClient.CancelVectorStoreFileBatchAsync

IOpenAIClient.CancelVectorStoreFileBatchAsync method

Cancels a specific vector store file batch asynchronously.

public Task<VectorStoreFileBatchResponse> CancelVectorStoreFileBatchAsync(string vectorStoreId, 
    string fileBatchId, CancellationToken? cancellationToken = default)
ParameterTypeDescription
vectorStoreIdStringThe ID of the vector store containing the file batch to cancel.
fileBatchIdStringThe ID of the file batch to cancel.
cancellationTokenNullable`1A token to cancel the operation.

Return Value

A task that represents the asynchronous operation. The task result contains the response from canceling the file batch.

Exceptions

exceptioncondition
AIClientExceptionThrown when the vector store Id is null or empty.
AIClientExceptionThrown when the vector store file batch Id is null or empty.

See Also