AssistantsClient.GetAssistantAsync(String, CancellationToken) 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.

Retrieves an existing assistant.

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

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

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

Parameters

assistantId: String

The ID of the assistant to retrieve.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<Assistant>>

Exceptions

ArgumentNullException

assistantId is null.

ArgumentException

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

Applies to

Share via