AgentsClient.GetRun Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetRun(String, String, RequestContext)	[Protocol Method] Gets an existing run from an existing thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRun(String, String, CancellationToken) convenience overload with strongly typed models first.
GetRun(String, String, CancellationToken)	Gets an existing run from an existing thread.

GetRun(String, String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Gets an existing run from an existing thread.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetRun(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetRun (string threadId, string runId, Azure.RequestContext context);

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

Public Overridable Function GetRun (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

Response

The response returned from the service.

Exceptions

ArgumentNullException

threadId or runId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetRun(String, String, CancellationToken)

Source:

AgentsClient.cs

Gets an existing run from an existing thread.

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

abstract member GetRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>
override this.GetRun : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>

Public Overridable Function GetRun (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

Response<ThreadRun>

Exceptions

ArgumentNullException

threadId or runId is null.

ArgumentException

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