Language

ProjectsAgentsModelFactory.AgentOptimizationResultCandidateSummary Method

Definition

Summary of candidates produced by an agent optimization job.

public static Azure.AI.Projects.Agents.AgentOptimizationResultCandidateSummary AgentOptimizationResultCandidateSummary(int completedCandidateCount = 0, string baselineId = default, string bestId = default, double? baselineScore = default, double? bestScore = default, Azure.AI.Projects.Agents.AgentOptimizationCandidatePromotionInfo latestPromotedCandidate = default);
static member AgentOptimizationResultCandidateSummary : int * string * string * Nullable<double> * Nullable<double> * Azure.AI.Projects.Agents.AgentOptimizationCandidatePromotionInfo -> Azure.AI.Projects.Agents.AgentOptimizationResultCandidateSummary
Public Shared Function AgentOptimizationResultCandidateSummary (Optional completedCandidateCount As Integer = 0, Optional baselineId As String = Nothing, Optional bestId As String = Nothing, Optional baselineScore As Nullable(Of Double) = Nothing, Optional bestScore As Nullable(Of Double) = Nothing, Optional latestPromotedCandidate As AgentOptimizationCandidatePromotionInfo = Nothing) As AgentOptimizationResultCandidateSummary

Parameters

completedCandidateCount
Int32

Number of completed candidates. Does not include the baseline.

baselineId
String

Candidate ID of the original baseline. Omitted until the baseline candidate is available.

bestId
String

Candidate ID of the highest-scoring candidate for evaluated jobs, or the selected transformed output for non-comparative jobs. Omitted until a candidate has been selected.

baselineScore
Nullable<Double>

Normalized score of the baseline candidate from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until baseline evaluation completes.

bestScore
Nullable<Double>

Best normalized score observed from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until a candidate completes evaluation.

latestPromotedCandidate
AgentOptimizationCandidatePromotionInfo

Most recently promoted candidate for the job. Omitted if no candidates have been promoted.

Returns

A new AgentOptimizationResultCandidateSummary instance for mocking.

Applies to