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

C#

public sealed class EvaluationResult

Inheritance

Object

EvaluationResult

Constructors

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

Properties

Metrics

Gets or sets a collection of one or more EvaluationMetrics that represent the result of an evaluation.

Methods

Get<T>(String)	Returns an EvaluationMetric with type T and with the Name specified via metricName if it exists in Metrics.
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