AssistantsClient.UpdateAssistantAsync Method

Reference

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

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.

Modifies an existing assistant.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.Assistant>> UpdateAssistantAsync (string assistantId, Azure.AI.OpenAI.Assistants.UpdateAssistantOptions updateAssistantOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAssistantAsync : string * Azure.AI.OpenAI.Assistants.UpdateAssistantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.Assistant>>
override this.UpdateAssistantAsync : string * Azure.AI.OpenAI.Assistants.UpdateAssistantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.Assistant>>

Public Overridable Function UpdateAssistantAsync (assistantId As String, updateAssistantOptions As UpdateAssistantOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Assistant))

Parameters

assistantId: String

The ID of the assistant to modify.

updateAssistantOptions: UpdateAssistantOptions

The request details to use when modifying an existing assistant.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<Assistant>>

Exceptions

ArgumentNullException

assistantId or updateAssistantOptions is null.

ArgumentException

assistantId is an empty string, and was expected to be non-empty.

Applies to

Share via