Share via


Evaluation Class

Definition

Evaluation Definition.

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

Constructors

Evaluation(InputData, IDictionary<String,EvaluatorConfiguration>)

Initializes a new instance of Evaluation.

Properties

Data

Data for evaluation. Please note InputData is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ApplicationInsightsConfiguration and Dataset.

Description

Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.

DisplayName

Display Name for evaluation. It helps to find evaluation easily in AI Studio. It does not need to be unique.

Evaluators

Evaluators to be used for the evaluation.

Id

Identifier of the evaluation.

Properties

Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

Status

Status of the evaluation. It is set by service and is read-only.

SystemData

Metadata containing createdBy and modifiedBy information.

Tags

Evaluation's tags. Unlike properties, tags are fully mutable.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<Evaluation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<Evaluation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<Evaluation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<Evaluation>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<Evaluation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to