SingleNumericMetricEvaluator Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI.Evaluation.Quality

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

Package:: Microsoft.Extensions.AI.Evaluation.Quality v9.3.0-preview.1.25114.11

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 abstract base class that can be used to implement an AI-based IEvaluator that produces an EvaluationResult containing a single NumericMetric.

public ref class SingleNumericMetricEvaluator abstract : Microsoft::Extensions::AI::Evaluation::Quality::ChatConversationEvaluator

public abstract class SingleNumericMetricEvaluator : Microsoft.Extensions.AI.Evaluation.Quality.ChatConversationEvaluator

type SingleNumericMetricEvaluator = class
    inherit ChatConversationEvaluator

Public MustInherit Class SingleNumericMetricEvaluator
Inherits ChatConversationEvaluator

Inheritance: Object

ChatConversationEvaluator
SingleNumericMetricEvaluator

Derived: Microsoft.Extensions.AI.Evaluation.Quality.CoherenceEvaluator

Microsoft.Extensions.AI.Evaluation.Quality.EquivalenceEvaluator

Microsoft.Extensions.AI.Evaluation.Quality.FluencyEvaluator

Microsoft.Extensions.AI.Evaluation.Quality.GroundednessEvaluator

Constructors

SingleNumericMetricEvaluator()

Properties

ChatOptions	Gets the ChatOptions that this IEvaluator uses when performing evaluations.
EvaluationMetricNames	Gets the Names of the EvaluationMetrics produced by this IEvaluator.
IgnoresHistory	Gets a value indicating whether this IEvaluator considers the entire conversation history (in addition to the request and response being evaluated) as part of the evaluation it performs. (Inherited from ChatConversationEvaluator)
MetricName	Gets the Name of the NumericMetric produced by this IEvaluator.
SystemPrompt	Gets the system prompt that this IEvaluator uses when performing evaluations.

Methods

CanRenderAsync(ChatMessage, Int32, ChatConfiguration, CancellationToken)	Determines if there is sufficient `tokenBudget` remaining to render the supplied `message` as part of the evaluation prompt that this IEvaluator uses. (Inherited from ChatConversationEvaluator)
EvaluateAsync(IEnumerable<ChatMessage>, ChatMessage, ChatConfiguration, IEnumerable<EvaluationContext>, CancellationToken)	Evaluates the supplied `modelResponse` and returns an EvaluationResult containing one or more EvaluationMetrics. (Inherited from ChatConversationEvaluator)
InitializeResult()	Returns an EvaluationResult that includes default values for all the EvaluationMetrics supported by this IEvaluator.
ParseEvaluationResponseAsync(String, EvaluationResult, ChatConfiguration, CancellationToken)	Parses the evaluation result present in `modelResponseForEvaluationPrompt` into the EvaluationMetrics present in the supplied `result`.
RenderAsync(ChatMessage, CancellationToken)	Renders the supplied `message` to a string that can be included as part of the evaluation prompt that this IEvaluator uses. (Inherited from ChatConversationEvaluator)
RenderEvaluationPromptAsync(ChatMessage, ChatMessage, IEnumerable<ChatMessage>, IEnumerable<EvaluationContext>, CancellationToken)	Renders the information present in the supplied parameters into a prompt that this IEvaluator uses to perform the evaluation. (Inherited from ChatConversationEvaluator)

Extension Methods

EvaluateAsync(IEvaluator, ChatMessage, ChatMessage, ChatConfiguration, IEnumerable<EvaluationContext>, CancellationToken)	Evaluates the supplied `modelResponse` and returns an EvaluationResult containing one or more EvaluationMetrics.
EvaluateAsync(IEvaluator, ChatMessage, ChatConfiguration, IEnumerable<EvaluationContext>, CancellationToken)	Evaluates the supplied `modelResponse` and returns an EvaluationResult containing one or more EvaluationMetrics.
EvaluateAsync(IEvaluator, String, ChatConfiguration, IEnumerable<EvaluationContext>, CancellationToken)	Evaluates the supplied `modelResponse` and returns an EvaluationResult containing one or more EvaluationMetrics.
EvaluateAsync(IEvaluator, String, String, ChatConfiguration, IEnumerable<EvaluationContext>, CancellationToken)	Evaluates the supplied `modelResponse` and returns an EvaluationResult containing one or more EvaluationMetrics.

Applies to

通过