AgentsClient.UpdateThread 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
| UpdateThread(String, RequestContent, RequestContext) |
[Protocol Method] Modifies an existing thread.
|
| UpdateThread(String, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) |
Modifies an existing thread. |
UpdateThread(String, RequestContent, RequestContext)
- Source:
- AgentsClient.cs
[Protocol Method] Modifies an existing thread.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler UpdateThread(String, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response UpdateThread (string threadId, Azure.Core.RequestContent content, Azure.RequestContext context = default);abstract member UpdateThread : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateThread : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.ResponsePublic Overridable Function UpdateThread (threadId As String, content As RequestContent, Optional context As RequestContext = Nothing) As ResponseParameters
- threadId
- String
The ID of the thread to modify.
- 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 or content is null.
threadId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
UpdateThread(String, ToolResources, IReadOnlyDictionary<String,String>, CancellationToken)
- Source:
- AgentsClient.cs
Modifies an existing thread.
public virtual Azure.Response<Azure.AI.Projects.AgentThread> UpdateThread (string threadId, Azure.AI.Projects.ToolResources toolResources = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);abstract member UpdateThread : string * Azure.AI.Projects.ToolResources * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.AgentThread>
override this.UpdateThread : string * Azure.AI.Projects.ToolResources * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.AgentThread>Public Overridable Function UpdateThread (threadId As String, Optional toolResources As ToolResources = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AgentThread)Parameters
- threadId
- String
The ID of the thread to modify.
- toolResources
- ToolResources
A set of resources that are made available to the agent's tools in this thread. The resources are specific to the
type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires
a list of vector store IDs
- 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 is null.
threadId is an empty string, and was expected to be non-empty.
Applies to
Azure SDK for .NET