AgentsClient.UpdateRun 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
UpdateRun(String, String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread run.
|
UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread run. |
UpdateRun(String, String, RequestContent, RequestContext)
- Source:
- AgentsClient.cs
[Protocol Method] Modifies an existing thread run.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response UpdateRun (string threadId, string runId, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member UpdateRun : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateRun : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function UpdateRun (threadId As String, runId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response
Parameters
- threadId
- String
Identifier of the thread.
- runId
- String
Identifier of the run.
- content
- RequestContent
The content to send as the body of the request.
- 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 content
is null.
threadId
or runId
is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
UpdateRun(String, String, IReadOnlyDictionary<String,String>, CancellationToken)
- Source:
- AgentsClient.cs
Modifies an existing thread run.
public virtual Azure.Response<Azure.AI.Projects.ThreadRun> UpdateRun (string threadId, string runId, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateRun : string * string * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>
override this.UpdateRun : string * string * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadRun>
Public Overridable Function UpdateRun (threadId As String, runId As String, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ThreadRun)
Parameters
- threadId
- String
Identifier of the thread.
- runId
- String
Identifier of the run.
- metadata
- IReadOnlyDictionary<String,String>
A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
- 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