AgentsClient.GetRunStep 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
| GetRunStep(String, String, String, RequestContext) |
[Protocol Method] Gets a single run step from a thread run.
|
| GetRunStep(String, String, String, CancellationToken) |
Gets a single run step from a thread run. |
GetRunStep(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 GetRunStep(String, String, String, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response GetRunStep (string threadId, string runId, string stepId, Azure.RequestContext context);abstract member GetRunStep : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetRunStep : string * string * string * Azure.RequestContext -> Azure.ResponsePublic Overridable Function GetRunStep (threadId As String, runId As String, stepId As String, context As RequestContext) As ResponseParameters
- 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
The response returned from the service.
Exceptions
threadId, runId or stepId is null.
threadId, runId or stepId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetRunStep(String, String, String, CancellationToken)
- Source:
- AgentsClient.cs
Gets a single run step from a thread run.
public virtual Azure.Response<Azure.AI.Projects.RunStep> GetRunStep (string threadId, string runId, string stepId, System.Threading.CancellationToken cancellationToken = default);abstract member GetRunStep : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.RunStep>
override this.GetRunStep : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.RunStep>Public Overridable Function GetRunStep (threadId As String, runId As String, stepId As String, Optional cancellationToken As CancellationToken = Nothing) As 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
Exceptions
threadId, runId or stepId is null.
threadId, runId or stepId is an empty string, and was expected to be non-empty.
Applies to
Azure SDK for .NET