AssistantsClient.GetAssistantFileAsync 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 a file attached to an assistant.

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

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

Public Overridable Function GetAssistantFileAsync (assistantId As String, fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AssistantFile))

Parameters

assistantId: String

The ID of the assistant associated with the attached file.

fileId: String

The ID of the file to retrieve.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<AssistantFile>>

Exceptions

ArgumentNullException

assistantId or fileId is null.

ArgumentException

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

Applies to

Share via