EvaluationResult 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 collection of one or more EvaluationMetrics that represent the result of an evaluation.

public ref class EvaluationResult sealed

public sealed class EvaluationResult

type EvaluationResult = class

Public NotInheritable Class EvaluationResult

Inheritance: Object
EvaluationResult

Constructors

EvaluationResult(EvaluationMetric[])	Initializes a new EvaluationResult instance.
EvaluationResult(IDictionary<String,EvaluationMetric>)	Initializes a new EvaluationResult instance.
EvaluationResult(IEnumerable<EvaluationMetric>)	Initializes a new EvaluationResult instance.

Properties

Metrics

A collection of one or more EvaluationMetrics that represent the result of an evaluation.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Get<T>(String)	Returns an EvaluationMetric with type `T` and with the Name specified via `metricName` if it exists in Metrics.
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)
TryGet<T>(String, T)	Returns an EvaluationMetric with type `T` and with the Name specified via `metricName` if it exists in Metrics.

Extension Methods

AddDiagnosticToAllMetrics(EvaluationResult, EvaluationDiagnostic)	Adds the supplied `diagnostic` to all EvaluationMetrics contained in the supplied `result`.
ContainsDiagnostics(EvaluationResult, Func<EvaluationDiagnostic,Boolean>)	Returns `true` if any EvaluationMetric contained in the supplied `result` contains an EvaluationDiagnostic matching the supplied `predicate`; `false` otherwise.
Interpret(EvaluationResult, Func<EvaluationMetric,EvaluationMetricInterpretation>)	Applies EvaluationMetricInterpretations to one or more EvaluationMetrics contained in the supplied `result`.

Applies to

Jaa