F1EvaluatorContext Class

Definition

Namespace:: Microsoft.Extensions.AI.Evaluation.NLP

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

Package:: Microsoft.Extensions.AI.Evaluation.NLP v9.7.0-preview.1.25356.2

Source:: F1EvaluatorContext.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.

Contextual information that the F1Evaluator uses to compute the F1 score for a response.

public ref class F1EvaluatorContext sealed : Microsoft::Extensions::AI::Evaluation::EvaluationContext

public sealed class F1EvaluatorContext : Microsoft.Extensions.AI.Evaluation.EvaluationContext

type F1EvaluatorContext = class
    inherit EvaluationContext

Public NotInheritable Class F1EvaluatorContext
Inherits EvaluationContext

Inheritance: Object

EvaluationContext
F1EvaluatorContext

Remarks

F1Evaluator measures the F1 score of a response compared to a reference response that is supplied via GroundTruth. F1 is a metric used to valuate the quality of machine-generated text. It is the ratio of the number of shared words between the generated response and the reference response.

Constructors

F1EvaluatorContext(String)

Initializes a new instance of the F1EvaluatorContext class.

Properties

Contents	Gets or sets a list of AIContent objects that include all the information present in this EvaluationContext. (Inherited from EvaluationContext)
GroundTruth	Gets the reference response against which the provided response will be scored.
GroundTruthContextName	Gets the unique Name that is used for F1EvaluatorContext.
Name	Gets or sets the name for this EvaluationContext. (Inherited from EvaluationContext)

Applies to