StringMetric Class

Definition

An EvaluationMetric containing a String value.

public ref class StringMetric sealed : Microsoft::Extensions::AI::Evaluation::EvaluationMetric<System::String ^>
public sealed class StringMetric : Microsoft.Extensions.AI.Evaluation.EvaluationMetric<string>
type StringMetric = class
    inherit EvaluationMetric<string>
Public NotInheritable Class StringMetric
Inherits EvaluationMetric(Of String)
Inheritance

Remarks

A common use case for StringMetric is to represent a single value in an enumeration (or to represent one value out of a set of possible values).

Constructors

StringMetric(String, String)

An EvaluationMetric containing a String value.

Properties

Diagnostics

Gets or sets a collection of zero or more EvaluationDiagnostics associated with the current EvaluationMetric.

(Inherited from 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.

(Inherited from EvaluationMetric)
Name

Gets or sets the name of the EvaluationMetric.

(Inherited from EvaluationMetric)
Value

Gets or sets the value of the EvaluationMetric<T>.

(Inherited from EvaluationMetric<T>)

Methods

AddDiagnostic(EvaluationDiagnostic)

Adds a EvaluationDiagnostic to the current EvaluationMetric's Diagnostics.

(Inherited from EvaluationMetric)

Extension Methods

ContainsDiagnostics(EvaluationMetric, Func<EvaluationDiagnostic,Boolean>)

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

Applies to