AgentsClient.GetRunStepAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

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

GetRunStepAsync(String, String, String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Gets a single run step from a thread run.

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetRunStepAsync (string threadId, string runId, string stepId, Azure.RequestContext context);

abstract member GetRunStepAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetRunStepAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetRunStepAsync (threadId As String, runId As String, stepId As String, context As RequestContext) As Task(Of Response)

Parameters

threadId

String

Identifier of the thread.

runId

String

Identifier of the run.

stepId

String

Identifier of the run step.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

threadId, runId or stepId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetRunStepAsync(String, String, String, CancellationToken)

Source:

AgentsClient.cs

Gets a single run step from a thread run.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.RunStep>> GetRunStepAsync (string threadId, string runId, string stepId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRunStepAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.RunStep>>
override this.GetRunStepAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.RunStep>>

Public Overridable Function GetRunStepAsync (threadId As String, runId As String, stepId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RunStep))

Parameters

threadId

String

Identifier of the thread.

runId

String

Identifier of the run.

stepId

String

Identifier of the run step.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<RunStep>>

Exceptions

ArgumentNullException

threadId, runId or stepId is null.

ArgumentException

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