Compartilhar via


AgentsClient.CancelRun Method

Definition

Overloads

CancelRun(String, String, RequestContext)

[Protocol Method] Cancels a run of an in progress thread.

CancelRun(String, String, CancellationToken)

Cancels a run of an in progress thread.

CancelRun(String, String, RequestContext)

Source:
AgentsClient.cs

[Protocol Method] Cancels a run of an in progress thread.

public virtual Azure.Response CancelRun (string threadId, string runId, Azure.RequestContext context);
abstract member CancelRun : string * string * Azure.RequestContext -> Azure.Response
override this.CancelRun : string * string * Azure.RequestContext -> Azure.Response
Public Overridable Function CancelRun (threadId As String, runId As String, context As RequestContext) As Response

Parameters

threadId
String

Identifier of the thread.

runId
String

Identifier of the run.

context
RequestContext

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

Returns

The response returned from the service.

Exceptions

threadId or runId is null.

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

Service returned a non-success status code.

Applies to

CancelRun(String, String, CancellationToken)

Source:
AgentsClient.cs

Cancels a run of an in progress thread.

public virtual Azure.Response<Azure.AI.Projects.ThreadRun> CancelRun (string threadId, string runId, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>
override this.CancelRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>
Public Overridable Function CancelRun (threadId As String, runId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ThreadRun)

Parameters

threadId
String

Identifier of the thread.

runId
String

Identifier of the run.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

threadId or runId is null.

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

Applies to