Language

AgentOptimizationJobCandidates.GetCandidateAsync Method

Definition

Overloads

Name Description
GetCandidateAsync(String, String, RequestOptions)

[Protocol Method] Retrieves a single candidate. Mutation values are always included.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCandidateAsync(String, String, CancellationToken)

Retrieves a single candidate. Mutation values are always included.

GetCandidateAsync(String, String, RequestOptions)

Source:
AgentOptimizationJobCandidates.cs

[Protocol Method] Retrieves a single candidate. Mutation values are always included.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> GetCandidateAsync(string jobId, string candidateId, System.ClientModel.Primitives.RequestOptions options);
abstract member GetCandidateAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.GetCandidateAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
Public Overridable Function GetCandidateAsync (jobId As String, candidateId As String, options As RequestOptions) As Task(Of ClientResult)

Parameters

jobId
String

The ID of the parent optimization job.

candidateId
String

The candidate identifier.

options
RequestOptions

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

Returns

The response returned from the service.

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.

Applies to

GetCandidateAsync(String, String, CancellationToken)

Source:
AgentOptimizationJobCandidates.cs

Retrieves a single candidate. Mutation values are always included.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentOptimizationCandidate>> 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.AgentOptimizationCandidate>>
override this.GetCandidateAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentOptimizationCandidate>>
Public Overridable Function GetCandidateAsync (jobId As String, candidateId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of AgentOptimizationCandidate))

Parameters

jobId
String

The ID of the parent optimization job.

candidateId
String

The candidate identifier.

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.

Applies to