AgentOptimizationResultCandidateSummary Class

  • java.lang.Object
    • com.azure.ai.agents.models.AgentOptimizationResultCandidateSummary

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 AgentOptimizationResultCandidateSummary fromJson(JsonReader jsonReader)

Reads an instance of AgentOptimizationResultCandidateSummary from the JsonReader.

String getBaselineId()

Get the baselineId property: Candidate ID of the original baseline.

Double getBaselineScore()

Get the baselineScore property: Normalized score of the baseline candidate from 0.0 to 1.0 for a comparatively evaluated job.

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.

Double getBestScore()

Get the bestScore property: Best normalized score observed from 0.0 to 1.0 for a comparatively evaluated job.

int getCompletedCandidateCount()

Get the completedCandidateCount property: Number of completed candidates.

AgentOptimizationCandidatePromotionInfo getLatestPromotedCandidate()

Get the latestPromotedCandidate property: Most recently promoted candidate for the job.

JsonWriter 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:

jsonReader - The JsonReader being read.

Returns:

An instance of AgentOptimizationResultCandidateSummary if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getBaselineId

public String getBaselineId()

Get the baselineId property: Candidate ID of the original baseline. Omitted until the baseline candidate is available.

Returns:

the baselineId value.

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:

the baselineScore value.

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:

the bestId value.

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:

the bestScore value.

getCompletedCandidateCount

public int getCompletedCandidateCount()

Get the completedCandidateCount property: Number of completed candidates. Does not include the baseline.

Returns:

the completedCandidateCount value.

getLatestPromotedCandidate

public AgentOptimizationCandidatePromotionInfo getLatestPromotedCandidate()

Get the latestPromotedCandidate property: Most recently promoted candidate for the job. Omitted if no candidates have been promoted.

Returns:

the latestPromotedCandidate value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to