ReportingConfiguration Class

Definition

Namespace:

Microsoft.Extensions.AI.Evaluation.Reporting

Assembly:

Microsoft.Extensions.AI.Evaluation.Reporting.dll

Package:

Microsoft.Extensions.AI.Evaluation.Reporting v9.3.0-preview.1.25114.11

Represents the configuration for a set of ScenarioRuns that defines the set of IEvaluators that should be invoked, the ChatConfiguration that should be used by these IEvaluators, how the resulting ScenarioRunResults should be persisted, and how AI responses should be cached.

public ref class ReportingConfiguration sealed

public sealed class ReportingConfiguration

type ReportingConfiguration = class

Public NotInheritable Class ReportingConfiguration

Inheritance

Object

ReportingConfiguration

Constructors

ReportingConfiguration(IEnumerable<IEvaluator>, IResultStore, ChatConfiguration, IResponseCacheProvider, IEnumerable<String>, String, Func<EvaluationMetric,EvaluationMetricInterpretation>)

Initializes a new instance of the ReportingConfiguration class.

Properties

CachingKeys	Gets the collection of unique strings that should be hashed when generating the cache keys for cached AI responses.
ChatConfiguration	Gets a ChatConfiguration that specifies the IChatClient and the IEvaluationTokenCounter that are used by AI-based Evaluators included in this ReportingConfiguration.
EvaluationMetricInterpreter	Gets a function that can be optionally used to override EvaluationMetricInterpretations for EvaluationMetrics returned from evaluations that use this ReportingConfiguration.
Evaluators	Gets the set of IEvaluators that should be invoked to evaluate AI responses.
ExecutionName	Gets the name of the current execution.
ResponseCacheProvider	Gets the IResponseCacheProvider that should be used to cache AI responses.
ResultStore	Gets the IResultStore that should be used to persist the ScenarioRunResults.

Methods

CreateScenarioRunAsync(String, String, IEnumerable<String>, CancellationToken)

Creates a new ScenarioRun with the specified scenarioName and iterationName.