AgentOptimizationJobs.PromoteCandidateAsync Method

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.3

Source:

AgentOptimizationJobs.cs

Promotes a candidate, recording the deployment timestamp and target agent version.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.PromoteCandidateResponse>> PromoteCandidateAsync(string jobId, string candidateId, Azure.AI.Projects.Agents.PromoteCandidateRequest candidateRequest, System.Threading.CancellationToken cancellationToken = default);

abstract member PromoteCandidateAsync : string * string * Azure.AI.Projects.Agents.PromoteCandidateRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.PromoteCandidateResponse>>
override this.PromoteCandidateAsync : string * string * Azure.AI.Projects.Agents.PromoteCandidateRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.PromoteCandidateResponse>>

Public Overridable Function PromoteCandidateAsync (jobId As String, candidateId As String, candidateRequest As PromoteCandidateRequest, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of PromoteCandidateResponse))

Parameters

jobId

String

The optimization job id.

candidateId

String

The candidate id to promote.

candidateRequest

PromoteCandidateRequest

Promotion details.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<ClientResult<PromoteCandidateResponse>>

Exceptions

ArgumentNullException

jobId, candidateId or candidateRequest is null.

ArgumentException

jobId or candidateId is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.