AgentOptimizationJobs.GetCandidateFileAsync 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.
Stream a specific file from the candidate's blob directory.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>> GetCandidateFileAsync(string jobId, string candidateId, string path, System.Threading.CancellationToken cancellationToken = default);abstract member GetCandidateFileAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>
override this.GetCandidateFileAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>Public Overridable Function GetCandidateFileAsync (jobId As String, candidateId As String, path As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of BinaryData))Parameters
- jobId
- String
The optimization job id.
- candidateId
- String
The candidate id.
- path
- String
Relative path of the file to download (e.g. 'files/examples.jsonl').
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobId, candidateId or path is null.
jobId, candidateId or path is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
