Language

AgentOptimizationResultCandidateSummary Class

Definition

Summary of candidates produced by an agent optimization job.

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

Properties

Name Description
BaselineId

Candidate ID of the original baseline. Omitted until the baseline candidate is available.

BaselineScore

Normalized score of the baseline candidate from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until baseline evaluation completes.

BestId

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.

BestScore

Best normalized score observed from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until a candidate completes evaluation.

CompletedCandidateCount

Number of completed candidates. Does not include the baseline.

LatestPromotedCandidate

Most recently promoted candidate for the job. Omitted if no candidates have been promoted.

Methods

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

Explicit Interface Implementations

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

Applies to