StringMetric Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI.Evaluation

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

Package:: Microsoft.Extensions.AI.Evaluation v9.5.0

Source:: StringMetric.cs

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 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: Object

EvaluationMetric

EvaluationMetric<String>
StringMetric

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, String)

An EvaluationMetric containing a String value.

Properties

Context	Gets or sets any EvaluationContexts that were considered by the IEvaluator as part of the evaluation that produced the current EvaluationMetric. (Inherited from EvaluationMetric)
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)
Metadata	Gets or sets a collection of zero or more string metadata associated with the current EvaluationMetric. (Inherited from EvaluationMetric)
Name	Gets or sets the name of the EvaluationMetric. (Inherited from EvaluationMetric)
Reason	Gets or sets a string that can optionally be used to provide some commentary around the result represented by this EvaluationMetric. (Inherited from EvaluationMetric)
Value	Gets or sets the value of the EvaluationMetric<T>. (Inherited from EvaluationMetric<T>)

Extension Methods

AddDiagnostics(EvaluationMetric, EvaluationDiagnostic[])	Adds the supplied EvaluationDiagnostics to the supplied EvaluationMetric's Diagnostics collection.
AddDiagnostics(EvaluationMetric, IEnumerable<EvaluationDiagnostic>)	Adds the supplied EvaluationDiagnostics to the supplied EvaluationMetric's Diagnostics collection.
AddOrUpdateChatMetadata(EvaluationMetric, ChatResponse, Nullable<TimeSpan>)	Adds or updates metadata available as part of the evaluation `response` produced by an AI model, in the supplied `metric`'s Metadata dictionary.
AddOrUpdateContext(EvaluationMetric, EvaluationContext[])	Adds or updates the supplied `context` objects in the supplied `metric`'s Context dictionary.
AddOrUpdateContext(EvaluationMetric, IEnumerable<EvaluationContext>)	Adds or updates the supplied `context` objects in the supplied `metric`'s Context dictionary.
AddOrUpdateMetadata(EvaluationMetric, IDictionary<String,String>)	Adds or updates the supplied `metadata` in the supplied `metric`'s Metadata dictionary.
AddOrUpdateMetadata(EvaluationMetric, String, String)	Adds or updates metadata with the specified `name` and `value` in the supplied `metric`'s Metadata dictionary.
ContainsDiagnostics(EvaluationMetric, Func<EvaluationDiagnostic,Boolean>)	Determines if the supplied `metric` contains any EvaluationDiagnostic matching the supplied `predicate`.

Applies to