IOpenAIClient.CancelRunAsync

IOpenAIClient.CancelRunAsync method

Cancels an existing run within a thread asynchronously.

public Task<RunResponse> CancelRunAsync(string threadId, string runId, 
    CancellationToken? cancellationToken = default)
ParameterTypeDescription
threadIdStringThe ID of the thread containing the run to cancel.
runIdStringThe ID of the run 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 the run cancellation.

Exceptions

exceptioncondition
AIClientExceptionThrown when the thread Id is null or empty.
AIClientExceptionThrown when the run Id is null or empty.

See Also