AgentOptimizationResultCandidateSummary Class
- java.
lang. Object - com.
azure. ai. agents. models. AgentOptimizationResultCandidateSummary
- com.
Implements
public final class AgentOptimizationResultCandidateSummary
implements JsonSerializable<AgentOptimizationResultCandidateSummary>
Summary of candidates produced by an agent optimization job.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Agent |
fromJson(JsonReader jsonReader)
Reads an instance of Agent |
| String |
getBaselineId()
Get the baseline |
| Double |
getBaselineScore()
Get the baseline |
| String |
getBestId()
Get the best |
| Double |
getBestScore()
Get the best |
| int |
getCompletedCandidateCount()
Get the completed |
|
Agent |
getLatestPromotedCandidate()
Get the latest |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Method Details
fromJson
public static AgentOptimizationResultCandidateSummary fromJson(JsonReader jsonReader)
Reads an instance of AgentOptimizationResultCandidateSummary from the JsonReader.
Parameters:
Returns:
Throws:
getBaselineId
public String getBaselineId()
Get the baselineId property: Candidate ID of the original baseline. Omitted until the baseline candidate is available.
Returns:
getBaselineScore
public Double getBaselineScore()
Get the baselineScore property: Normalized score of the baseline candidate from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until baseline evaluation completes.
Returns:
getBestId
public String getBestId()
Get the bestId property: 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.
Returns:
getBestScore
public Double getBestScore()
Get the bestScore property: Best normalized score observed from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until a candidate completes evaluation.
Returns:
getCompletedCandidateCount
public int getCompletedCandidateCount()
Get the completedCandidateCount property: Number of completed candidates. Does not include the baseline.
Returns:
getLatestPromotedCandidate
public AgentOptimizationCandidatePromotionInfo getLatestPromotedCandidate()
Get the latestPromotedCandidate property: Most recently promoted candidate for the job. Omitted if no candidates have been promoted.
Returns: