AgentOptimizationJobs.GetCandidateAsync 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.
Get a single candidate's metadata, manifest, and promotion info.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.CandidateMetadata>> GetCandidateAsync(string jobId, string candidateId, System.Threading.CancellationToken cancellationToken = default);abstract member GetCandidateAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.CandidateMetadata>>
override this.GetCandidateAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.CandidateMetadata>>Public Overridable Function GetCandidateAsync (jobId As String, candidateId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of CandidateMetadata))Parameters
- jobId
- String
The optimization job id.
- candidateId
- String
The candidate id.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobId or candidateId is null.
jobId or candidateId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
