AssistantsClient.CancelRun(String, String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.AI.OpenAI.Assistants

Assembly:: Azure.AI.OpenAI.Assistants.dll

Package:: Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:: AssistantsClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Cancels a run of an in progress thread.

public virtual Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun> CancelRun (string threadId, string runId, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>
override this.CancelRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>

Public Overridable Function CancelRun (threadId As String, runId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ThreadRun)

Parameters

threadId: String

The ID of the thread being run.

runId: String

The ID of the run to cancel.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<ThreadRun>

Exceptions

ArgumentNullException

threadId or runId is null.

ArgumentException

threadId or runId is an empty string, and was expected to be non-empty.

Applies to

Share via