AssistantsClient.GetFileAsync(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.

Returns information about a specific file. Does not retrieve file content.

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

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

Public Overridable Function GetFileAsync (fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of OpenAIFile))

Parameters

fileId: String

The ID of the file to retrieve.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<OpenAIFile>>

Exceptions

ArgumentNullException

fileId is null.

ArgumentException

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

Applies to

Share via