AssistantsClient.UpdateRunAsync Method

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:

AssistantsClient.cs

Modifies an existing thread run.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>> UpdateRunAsync (string threadId, string runId, System.Collections.Generic.IDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateRunAsync : string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>>
override this.UpdateRunAsync : string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.ThreadRun>>

Public Overridable Function UpdateRunAsync (threadId As String, runId As String, Optional metadata As IDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ThreadRun))

Parameters

threadId

String

The ID of the thread associated with the specified run.

runId

String

The ID of the run to modify.

metadata

IDictionary<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

Task<Response<ThreadRun>>

Exceptions

ArgumentNullException

threadId or runId is null.

ArgumentException

threadId or runId is an empty string, and was expected to be non-empty.