AssistantsClient.GetRunSteps Method
Definition
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.
Overloads
| GetRunSteps(ThreadRun, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of run steps associated an assistant 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:
- AssistantsClient.cs
Returns a list of run steps associated an assistant thread run.
public virtual Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.RunStep>> GetRunSteps (Azure.AI.OpenAI.Assistants.ThreadRun run, int? limit = default, Azure.AI.OpenAI.Assistants.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetRunSteps : Azure.AI.OpenAI.Assistants.ThreadRun * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.RunStep>>
override this.GetRunSteps : Azure.AI.OpenAI.Assistants.ThreadRun * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.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
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
Exceptions
run is null.
Applies to
GetRunSteps(String, String, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)
- Source:
- AssistantsClient.cs
Gets a list of run steps from a thread run.
public virtual Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.RunStep>> GetRunSteps (string threadId, string runId, int? limit = default, Azure.AI.OpenAI.Assistants.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetRunSteps : string * string * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.RunStep>>
override this.GetRunSteps : string * string * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.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
The ID of the thread that was run.
- runId
- String
The ID of the run to list steps from.
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
Exceptions
threadId or runId is null.
threadId or runId is an empty string, and was expected to be non-empty.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for