AgentsClient.GetRunSteps Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetRunSteps(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Returns a list of run steps associated an agent thread run.
GetRunSteps(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)	Gets a list of run steps from a thread run.

GetRunSteps(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)

Source:

AgentsClient.cs

Returns a list of run steps associated an agent thread run.

public virtual Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>> GetRunSteps (Azure.AI.Projects.ThreadRun run, int? limit = default, Azure.AI.Projects.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRunSteps : Azure.AI.Projects.ThreadRun * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>>
override this.GetRunSteps : Azure.AI.Projects.ThreadRun * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>>

Public Overridable Function GetRunSteps (run As ThreadRun, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of ListSortOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PageableList(Of RunStep))

Parameters

run

ThreadRun

The ThreadRun instance from which run steps should be listed.

limit

Nullable<Int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order

Nullable<ListSortOrder>

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after

String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before

String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<PageableList<RunStep>>

Exceptions

ArgumentNullException

run is null.

GetRunSteps(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)

Source:

AgentsClient.cs

Gets a list of run steps from a thread run.

public virtual Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>> GetRunSteps (string threadId, string runId, int? limit = default, Azure.AI.Projects.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRunSteps : string * string * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>>
override this.GetRunSteps : string * string * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.RunStep>>

Public Overridable Function GetRunSteps (threadId As String, runId As String, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of ListSortOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PageableList(Of RunStep))

Parameters

threadId

String

Identifier of the thread.

runId

String

Identifier of the run.

limit

Nullable<Int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order

Nullable<ListSortOrder>

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after

String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before

String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<PageableList<RunStep>>

Exceptions

ArgumentNullException

threadId or runId is null.

ArgumentException

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