RetrievalEvaluatorContext Class

Reference

Definition

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

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

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

Source:: RetrievalEvaluatorContext.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 RetrievalEvaluator uses to evaluate an AI system's performance in retrieving information for additional context.

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

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

type RetrievalEvaluatorContext = class
    inherit EvaluationContext

Public NotInheritable Class RetrievalEvaluatorContext
Inherits EvaluationContext

Inheritance: Object

EvaluationContext
RetrievalEvaluatorContext

Remarks

RetrievalEvaluator measures the degree to which the information present in the context chunks supplied via RetrievedContextChunks are relevant to the user request, and how well these chunks are ranked (with the most relevant information appearing before less relevant information).

High retrieval scores indicate that the AI system has successfully extracted and ranked the most relevant information at the top, without introducing bias from external knowledge and ignoring factual correctness. Conversely, low retrieval scores suggest that the AI system has failed to surface the most relevant context chunks at the top of the list and / or introduced bias and ignored factual correctness.

Constructors

RetrievalEvaluatorContext(IEnumerable<String>)	Initializes a new instance of the RetrievalEvaluatorContext class.
RetrievalEvaluatorContext(String[])	Initializes a new instance of the RetrievalEvaluatorContext class.

Properties

Contents	Gets or sets a list of AIContent objects that include all the information present in this EvaluationContext. (Inherited from EvaluationContext)
Name	Gets or sets the name for this EvaluationContext. (Inherited from EvaluationContext)
RetrievedContextChunks	Gets the context chunks that were retrieved in response to the user request being evaluated.
RetrievedContextChunksContextName	Gets the unique Name that is used for RetrievalEvaluatorContext.

Applies to