NumericMetric(String, Nullable<Double>) Constructor
Definition
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.
An EvaluationMetric containing a numeric value.
public NumericMetric(string name, double? value = default);
new Microsoft.Extensions.AI.Evaluation.NumericMetric : string * Nullable<double> -> Microsoft.Extensions.AI.Evaluation.NumericMetric
Public Sub New (name As String, Optional value As Nullable(Of Double) = Nothing)
Parameters
- name
- String
The name of the NumericMetric.
The value of the NumericMetric.
Remarks
NumericMetric can be used to represent any numeric value. The underlying type of a NumericMetric's value is double
. However, it can be used to represent any type of numeric value including int
, long
, float
etc.
A common use case for NumericMetric is to represent numeric scores that fall within a well defined range. For example, it can be used to represent a score between 1 and 5, where 1 is considered a poor score, and 5 is considered an excellent score.