Language

AgentOptimizationJobCandidates Class

Definition

The AgentOptimizationJobCandidates sub-client.

public class AgentOptimizationJobCandidates
type AgentOptimizationJobCandidates = class
Public Class AgentOptimizationJobCandidates
Inheritance
AgentOptimizationJobCandidates

Constructors

Name Description
AgentOptimizationJobCandidates()

Initializes a new instance of AgentOptimizationJobCandidates for mocking.

Properties

Name Description
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name Description
GetCandidate(String, String, CancellationToken)

Retrieves a single candidate. Mutation values are always included.

GetCandidate(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)

[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.
GetCandidates(String, IEnumerable<AgentOptimizationCandidateExpand>, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each output.mutations item identifies a changed attribute by type; mutation value fields are omitted unless the client passes expand=mutations.

GetCandidates(String, IEnumerable<AgentOptimizationCandidateExpand>, Nullable<Int32>, String, String, String, RequestOptions)

[Protocol Method] Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each output.mutations item identifies a changed attribute by type; mutation value fields are omitted unless the client passes expand=mutations.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCandidatesAsync(String, IEnumerable<AgentOptimizationCandidateExpand>, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each output.mutations item identifies a changed attribute by type; mutation value fields are omitted unless the client passes expand=mutations.

GetCandidatesAsync(String, IEnumerable<AgentOptimizationCandidateExpand>, Nullable<Int32>, String, String, String, RequestOptions)

[Protocol Method] Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each output.mutations item identifies a changed attribute by type; mutation value fields are omitted unless the client passes expand=mutations.

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

Promotes a candidate to the Foundry agent stored in the parent job's target configuration. Promotion is unavailable when the job omitted target_configuration. Prompt-agent promotion creates a new agent version. Hosted-agent promotion currently records promotion metadata without deploying a new hosted-agent version.

PromoteCandidate(String, String, RequestOptions)

[Protocol Method] Promotes a candidate to the Foundry agent stored in the parent job's target configuration. Promotion is unavailable when the job omitted target_configuration. Prompt-agent promotion creates a new agent version. Hosted-agent promotion currently records promotion metadata without deploying a new hosted-agent version.

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

Promotes a candidate to the Foundry agent stored in the parent job's target configuration. Promotion is unavailable when the job omitted target_configuration. Prompt-agent promotion creates a new agent version. Hosted-agent promotion currently records promotion metadata without deploying a new hosted-agent version.

PromoteCandidateAsync(String, String, RequestOptions)

[Protocol Method] Promotes a candidate to the Foundry agent stored in the parent job's target configuration. Promotion is unavailable when the job omitted target_configuration. Prompt-agent promotion creates a new agent version. Hosted-agent promotion currently records promotion metadata without deploying a new hosted-agent version.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to