AgentsClient.GetFileAsync Method
Definition
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.
Overloads
| GetFileAsync(String, RequestContext) |
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
|
| GetFileAsync(String, CancellationToken) |
Returns information about a specific file. Does not retrieve file content. |
GetFileAsync(String, RequestContext)
- Source:
- AgentsClient.cs
[Protocol Method] Returns information about a specific file. Does not retrieve file content.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetFileAsync(String, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetFileAsync (string fileId, Azure.RequestContext context);abstract member GetFileAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetFileAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetFileAsync (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
The response returned from the service.
Exceptions
fileId is null.
fileId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetFileAsync(String, CancellationToken)
- Source:
- AgentsClient.cs
Returns information about a specific file. Does not retrieve file content.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentFile>> GetFileAsync (string fileId, System.Threading.CancellationToken cancellationToken = default);abstract member GetFileAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentFile>>
override this.GetFileAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentFile>>Public Overridable Function GetFileAsync (fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AgentFile))Parameters
- fileId
- String
The ID of the file to retrieve.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
fileId is null.
fileId is an empty string, and was expected to be non-empty.
Applies to
Azure SDK for .NET