AgentOptimizationCandidate Class
- java.
lang. Object - com.
azure. ai. agents. models. AgentOptimizationCandidate
- com.
Implements
public final class AgentOptimizationCandidate
implements JsonSerializable<AgentOptimizationCandidate>
A candidate generated by an optimization job.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Agent |
fromJson(JsonReader jsonReader)
Reads an instance of Agent |
| String |
getAgentVersion()
Get the agent |
| String |
getCandidateId()
Get the candidate |
|
Agent |
getEvaluation()
Get the evaluation property: Comparative evaluation summary. |
| String |
getJobId()
Get the job |
| String |
getName()
Get the name property: Display name of the candidate (e. |
|
Agent |
getOutput()
Get the output property: Typed output generated for this candidate. |
|
Agent |
getPromotion()
Get the promotion property: Promotion metadata. |
| String |
getRationale()
Get the rationale property: Human-readable explanation of why the optimizer produced this candidate. |
|
Offset |
getStartedAt()
Get the started |
|
Agent |
getStatus()
Get the status property: The candidate's current lifecycle state. |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Method Details
fromJson
public static AgentOptimizationCandidate fromJson(JsonReader jsonReader)
Reads an instance of AgentOptimizationCandidate from the JsonReader.
Parameters:
Returns:
Throws:
getAgentVersion
public String getAgentVersion()
Get the agentVersion property: Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.
Returns:
getCandidateId
public String getCandidateId()
Get the candidateId property: Server-assigned candidate identifier.
Returns:
getEvaluation
public AgentOptimizationCandidateEvaluation getEvaluation()
Get the evaluation property: Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.
Returns:
getJobId
public String getJobId()
Get the jobId property: Identifier of the parent optimization job.
Returns:
getName
public String getName()
Get the name property: Display name of the candidate (e.g., 'baseline', 'instruction-v2').
Returns:
getOutput
public AgentOptimizationCandidateOutput getOutput()
Get the output property: Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.
Returns:
getPromotion
public AgentOptimizationCandidatePromotionInfo getPromotion()
Get the promotion property: Promotion metadata. Omitted if this candidate has not been promoted.
Returns:
getRationale
public String getRationale()
Get the rationale property: Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.
Returns:
getStartedAt
public OffsetDateTime getStartedAt()
Get the startedAt property: Timestamp when work on this candidate slot began, represented in Unix time.
Returns:
getStatus
public AgentOptimizationCandidateStatus getStatus()
Get the status property: The candidate's current lifecycle state.
Returns: