Sprog

AgentOptimizationCandidate Class

Definition

A candidate generated by an optimization job.

public class AgentOptimizationCandidate : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.AgentOptimizationCandidate>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.AgentOptimizationCandidate>
type AgentOptimizationCandidate = class
    interface IJsonModel<AgentOptimizationCandidate>
    interface IPersistableModel<AgentOptimizationCandidate>
Public Class AgentOptimizationCandidate
Implements IJsonModel(Of AgentOptimizationCandidate), IPersistableModel(Of AgentOptimizationCandidate)
Inheritance
AgentOptimizationCandidate
Implements

Properties

Name Description
AgentVersion

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

CandidateId

Server-assigned candidate identifier.

Evaluation

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

JobId

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.

StartedOn

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

Status

The candidate's current lifecycle state.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to AgentOptimizationCandidate)

Explicit Interface Implementations

Name Description
IJsonModel<AgentOptimizationCandidate>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AgentOptimizationCandidate>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AgentOptimizationCandidate>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AgentOptimizationCandidate>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AgentOptimizationCandidate>.Write(ModelReaderWriterOptions)

Applies to