EvaluationMetric Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI.Evaluation

Assembly:: Microsoft.Extensions.AI.Evaluation.dll

Package:: Microsoft.Extensions.AI.Evaluation v0.9.56-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A base class that represents the result of an evaluation.

public ref class EvaluationMetric

[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

[<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")>]
type EvaluationMetric = class

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	A collection of zero or more EvaluationDiagnostics associated with the current EvaluationMetric.
Interpretation	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	The name of the EvaluationMetric.

Methods

AddDiagnostic(EvaluationDiagnostic)	Adds a EvaluationDiagnostic to the current EvaluationMetric's Diagnostics.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

ContainsDiagnostics(EvaluationMetric, Func<EvaluationDiagnostic,Boolean>)

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

Applies to

Jaa