ReportingConfiguration Class

Definition

Namespace:

Microsoft.Extensions.AI.Evaluation.Reporting

Assembly:

Microsoft.Extensions.AI.Evaluation.Reporting.dll

Package:

Microsoft.Extensions.AI.Evaluation.Reporting v0.9.56-preview

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

Properties

CachingKeys	An optional collection of unique strings that should be hashed when generating the cache keys for cached AI responses.
ChatConfiguration	A ChatConfiguration that specifies the IChatClient and the IEvaluationTokenCounter that are used by AI-based Evaluators included in this ReportingConfiguration.
EvaluationMetricInterpreter	An optional function that can be used to override EvaluationMetricInterpretations for EvaluationMetrics returned from evaluations that use this ReportingConfiguration.
Evaluators	The set of IEvaluators that should be invoked to evaluate AI responses.
ExecutionName	The name of the current execution.
ResponseCacheProvider	The IResponseCacheProvider that should be used to cache AI responses.
ResultStore	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.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)