ProjectsAgentsModelFactory.AgentOptimizationCandidate Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A candidate generated by an optimization job.
public static Azure.AI.Projects.Agents.AgentOptimizationCandidate AgentOptimizationCandidate(string candidateId = default, string jobId = default, string name = default, Azure.AI.Projects.Agents.AgentOptimizationCandidateStatus status = default, DateTimeOffset startedOn = default, Azure.AI.Projects.Agents.AgentOptimizationCandidateOutput output = default, string rationale = default, string agentVersion = default, Azure.AI.Projects.Agents.AgentOptimizationCandidateEvaluation evaluation = default, Azure.AI.Projects.Agents.AgentOptimizationCandidatePromotionInfo promotion = default);
static member AgentOptimizationCandidate : string * string * string * Azure.AI.Projects.Agents.AgentOptimizationCandidateStatus * DateTimeOffset * Azure.AI.Projects.Agents.AgentOptimizationCandidateOutput * string * string * Azure.AI.Projects.Agents.AgentOptimizationCandidateEvaluation * Azure.AI.Projects.Agents.AgentOptimizationCandidatePromotionInfo -> Azure.AI.Projects.Agents.AgentOptimizationCandidate
Public Shared Function AgentOptimizationCandidate (Optional candidateId As String = Nothing, Optional jobId As String = Nothing, Optional name As String = Nothing, Optional status As AgentOptimizationCandidateStatus = Nothing, Optional startedOn As DateTimeOffset = Nothing, Optional output As AgentOptimizationCandidateOutput = Nothing, Optional rationale As String = Nothing, Optional agentVersion As String = Nothing, Optional evaluation As AgentOptimizationCandidateEvaluation = Nothing, Optional promotion As AgentOptimizationCandidatePromotionInfo = Nothing) As AgentOptimizationCandidate
Parameters
- candidateId
- String
Server-assigned candidate identifier.
- jobId
- String
Identifier of the parent optimization job.
- name
- String
Display name of the candidate (e.g., 'baseline', 'instruction-v2').
The candidate's current lifecycle state.
- startedOn
- DateTimeOffset
Timestamp when work on this candidate slot began, represented in Unix time.
Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.
- rationale
- String
Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.
- agentVersion
- String
Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.
- evaluation
- AgentOptimizationCandidateEvaluation
Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.
- promotion
- AgentOptimizationCandidatePromotionInfo
Promotion metadata. Omitted if this candidate has not been promoted.
Returns
A new AgentOptimizationCandidate instance for mocking.