AgentsClient.GetFileContentAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Overloads

GetFileContentAsync(String, RequestContext)	[Protocol Method] Retrieves the raw content of a specific file. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetFileContentAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetFileContentAsync(String, CancellationToken)	Retrieves the raw content of a specific file.

GetFileContentAsync(String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Retrieves the raw content of a specific file.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetFileContentAsync(String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetFileContentAsync (string fileId, Azure.RequestContext context);

abstract member GetFileContentAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetFileContentAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetFileContentAsync (fileId As String, context As RequestContext) As Task(Of Response)

Parameters

fileId

String

The ID of the file to retrieve.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

fileId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetFileContentAsync(String, CancellationToken)

Source:

AgentsClient.cs

Retrieves the raw content of a specific file.

public virtual System.Threading.Tasks.Task<Azure.Response<BinaryData>> GetFileContentAsync (string fileId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetFileContentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>
override this.GetFileContentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>

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

Parameters

fileId

String

The ID of the file to retrieve.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<BinaryData>>

Exceptions

ArgumentNullException

fileId is null.

ArgumentException

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