Language

EvaluatorVersion Class

Definition

Namespace:
Azure.AI.Projects.Evaluation
Assembly:
Azure.AI.Projects.dll
Package:
Azure.AI.Projects v2.0.1
Package:
Azure.AI.Projects v3.0.0-beta.1
Source:
EvaluatorVersion.cs
Source:
EvaluatorVersion.cs

Evaluator Definition.

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

Constructors

Name Description
EvaluatorVersion(EvaluatorType, IEnumerable<EvaluatorCategory>, EvaluatorDefinition)

Initializes a new instance of EvaluatorVersion.

Properties

Name Description
Categories

The categories of the evaluator.
CreatedAt

Creation date/time of the evaluator.
CreatedBy

Creator of the evaluator.
Definition

Definition of the evaluator.
Description

The asset description text.
DisplayName

Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
EvaluatorType

The type of the evaluator.
GenerationArtifacts

Provenance artifacts from the generation pipeline. Read-only; present only on evaluator versions created via an EvaluatorGenerationJob. Each artifact resolves to a versioned Foundry Dataset.
GenerationJobId

Read-only provenance link back to the EvaluatorGenerationJob that produced this version. Present only on evaluator versions created via the generation pipeline; absent for manually-created versions and unaffected by subsequent PATCH calls.
Id

Asset ID, a unique identifier for the asset.
Metadata

Metadata about the evaluator.
ModifiedAt

Last modified date/time of the evaluator.
Name

The name of the resource.
SupportedEvaluationLevels

Evaluation levels this evaluator supports (e.g., turn, conversation). When omitted on create, the service defaults to ["turn"]. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only turn; custom prompt-based evaluators support exactly one level (turn or conversation).
Tags

Tag dictionary. Tags can be added, removed, and updated.
Version

The version of the resource.
Warnings

Categories of warnings surfaced on this generated evaluator version. Present only on versions created via an EvaluatorGenerationJob when the paired job produced non-empty warnings. Absent (treat as no warnings) when the version is not from generation, when the paired job was clean, or when a subsequent PATCH to definition cleared the paired job's advisories. Follow generation_job_id to fetch the detailed warning payloads.

Methods

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

Operators

Name Description
Explicit(ClientResult to EvaluatorVersion)
Implicit(EvaluatorVersion to BinaryContent)

Explicit Interface Implementations

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

Applies to