ThreadRuns.GetRunStepAsync 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.
Retrieves a single run step from a thread run.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, System.Collections.Generic.IEnumerable<Azure.AI.Agents.Persistent.RunAdditionalFieldList> include = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetRunStepAsync : string * string * string * seq<Azure.AI.Agents.Persistent.RunAdditionalFieldList> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.RunStep>>
override this.GetRunStepAsync : string * string * string * seq<Azure.AI.Agents.Persistent.RunAdditionalFieldList> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.RunStep>>Public Overridable Function GetRunStepAsync (threadId As String, runId As String, stepId As String, Optional include As IEnumerable(Of RunAdditionalFieldList) = Nothing, 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.
- include
- IEnumerable<RunAdditionalFieldList>
A list of additional fields to include in the response.
Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
threadId, runId or stepId is null.
threadId, runId or stepId is an empty string, and was expected to be non-empty.
