ReportingConfiguration Constructor
Definition
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.
Initializes a new instance of the ReportingConfiguration class.
public ReportingConfiguration(System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.Evaluation.IEvaluator> evaluators, Microsoft.Extensions.AI.Evaluation.Reporting.IEvaluationResultStore resultStore, Microsoft.Extensions.AI.Evaluation.ChatConfiguration? chatConfiguration = default, Microsoft.Extensions.AI.Evaluation.Reporting.IEvaluationResponseCacheProvider? responseCacheProvider = default, System.Collections.Generic.IEnumerable<string>? cachingKeys = default, string executionName = "Default", Func<Microsoft.Extensions.AI.Evaluation.EvaluationMetric,Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation?>? evaluationMetricInterpreter = default, System.Collections.Generic.IEnumerable<string>? tags = default);new Microsoft.Extensions.AI.Evaluation.Reporting.ReportingConfiguration : seq<Microsoft.Extensions.AI.Evaluation.IEvaluator> * Microsoft.Extensions.AI.Evaluation.Reporting.IEvaluationResultStore * Microsoft.Extensions.AI.Evaluation.ChatConfiguration * Microsoft.Extensions.AI.Evaluation.Reporting.IEvaluationResponseCacheProvider * seq<string> * string * Func<Microsoft.Extensions.AI.Evaluation.EvaluationMetric, Microsoft.Extensions.AI.Evaluation.EvaluationMetricInterpretation> * seq<string> -> Microsoft.Extensions.AI.Evaluation.Reporting.ReportingConfigurationPublic Sub New (evaluators As IEnumerable(Of IEvaluator), resultStore As IEvaluationResultStore, Optional chatConfiguration As ChatConfiguration = Nothing, Optional responseCacheProvider As IEvaluationResponseCacheProvider = Nothing, Optional cachingKeys As IEnumerable(Of String) = Nothing, Optional executionName As String = "Default", Optional evaluationMetricInterpreter As Func(Of EvaluationMetric, EvaluationMetricInterpretation) = Nothing, Optional tags As IEnumerable(Of String) = Nothing)Parameters
- evaluators
- IEnumerable<IEvaluator>
The set of IEvaluators that should be invoked to evaluate AI responses.
- resultStore
- IEvaluationResultStore
The IEvaluationResultStore that should be used to persist the ScenarioRunResults.
- chatConfiguration
- ChatConfiguration
A ChatConfiguration that specifies the IChatClient that is used by
AI-based evaluators included in this ReportingConfiguration. Can be omitted if
none of the included evaluators are AI-based.
- responseCacheProvider
- IEvaluationResponseCacheProvider
The IEvaluationResponseCacheProvider that should be used to cache AI responses. If omitted, AI responses will not be cached.
- cachingKeys
- IEnumerable<String>
An optional collection of unique strings that should be hashed when generating the cache keys for cached AI responses. See CachingKeys for more information about this concept.
- executionName
- String
The name of the current execution. See ExecutionName for more information about this
concept. Uses a fixed default value "Default" if omitted.
- evaluationMetricInterpreter
- Func<EvaluationMetric,EvaluationMetricInterpretation>
An optional function that can be used to override EvaluationMetricInterpretations for
EvaluationMetrics returned from evaluations that use this ReportingConfiguration.
The supplied function can either return a new EvaluationMetricInterpretation for any
EvaluationMetric that is supplied to it, or return null if the
Interpretation should be left unchanged.
- tags
- IEnumerable<String>
A optional set of text tags applicable to all ScenarioRuns created using this ReportingConfiguration.
