AgentOptimizationCandidate interface

Package:

@azure/ai-projects

A candidate generated by an optimization job.

Properties

agent_version	Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.
candidate_id	Server-assigned candidate identifier.
evaluation	Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.
job_id	Identifier of the parent optimization job.
name	Display name of the candidate (e.g., 'baseline', 'instruction-v2').
output	Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.
promotion	Promotion metadata. Omitted if this candidate has not been promoted.
rationale	Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.
started_at	Timestamp when work on this candidate slot began, represented in Unix time.
status	The candidate's current lifecycle state.

Property Details

agent_version

Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.

agent_version?: string

Property Value

string

candidate_id

Server-assigned candidate identifier.

candidate_id: string

Property Value

string

evaluation

Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.

evaluation?: AgentOptimizationCandidateEvaluation

Property Value

AgentOptimizationCandidateEvaluation

job_id

Identifier of the parent optimization job.

job_id: string

Property Value

string

name

Display name of the candidate (e.g., 'baseline', 'instruction-v2').

name: string

Property Value

string

output

Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.

output?: AgentOptimizationCandidateOutputUnion

Property Value

AgentOptimizationCandidateOutputUnion

promotion

Promotion metadata. Omitted if this candidate has not been promoted.

promotion?: AgentOptimizationCandidatePromotionInfo

Property Value

AgentOptimizationCandidatePromotionInfo

rationale

Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.

rationale?: string

Property Value

string

started_at

Timestamp when work on this candidate slot began, represented in Unix time.

started_at: Date

Property Value

Date

status

The candidate's current lifecycle state.

status: AgentOptimizationCandidateStatus

Property Value

AgentOptimizationCandidateStatus