EvaluationMetric Class

Definition

Namespace:

Microsoft.Extensions.AI.Evaluation

Assembly:

Microsoft.Extensions.AI.Evaluation.dll

Package:

Microsoft.Extensions.AI.Evaluation v9.3.0-preview.1.25126.9

A base class that represents the result of an evaluation.

C#

[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.NumericMetric), "numeric")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.BooleanMetric), "boolean")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.StringMetric), "string")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Evaluation.EvaluationMetric), "none")]
public class EvaluationMetric

Inheritance

Object

EvaluationMetric

Derived

Microsoft.Extensions.AI.Evaluation.EvaluationMetric<T>

Attributes

JsonDerivedTypeAttribute

Constructors

EvaluationMetric(String)

A base class that represents the result of an evaluation.

Properties

Diagnostics	Gets or sets a collection of zero or more EvaluationDiagnostics associated with the current EvaluationMetric.
Interpretation	Gets or sets an EvaluationMetricInterpretation that identifies whether the result of the evaluation represented by the current EvaluationMetric is considered good or bad, passed or failed etc.
Name	Gets or sets the name of the EvaluationMetric.

Methods

AddDiagnostic(EvaluationDiagnostic)

Adds a EvaluationDiagnostic to the current EvaluationMetric's Diagnostics.

Extension Methods

ContainsDiagnostics(EvaluationMetric, Func<EvaluationDiagnostic,Boolean>)

Returns true if the supplied metric contains any EvaluationDiagnostic matching the supplied predicate; false otherwise.

Applies to