Microsoft.Extensions.AI.Evaluation.Reporting Namespace
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.
Contains classes for generating reports based on AI evaluation metrics and for caching AI model responses.
Classes
| ChatDetails |
A class that records details related to all LLM chat conversation turns involved in the execution of a particular ScenarioRun. |
| ChatDetailsExtensions |
Extension methods for ChatDetails. |
| ChatTurnDetails |
A class that records details related to a particular LLM chat conversation turn involved in the execution of a particular ScenarioRun. |
| Defaults |
A static class that contains default values for various reporting artifacts. |
| ReportingConfiguration |
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. |
| ScenarioRun |
Represents a single execution of a particular iteration of a particular scenario under evaluation. |
| ScenarioRunExtensions |
Extension methods for ScenarioRun. |
| ScenarioRunResult |
Represents the results of a single execution of a particular iteration of a particular scenario under evaluation. In other words, ScenarioRunResult represents the results of evaluating a ScenarioRun and includes the EvaluationResult that is produced when EvaluateAsync(IEnumerable<ChatMessage>, ChatResponse, IEnumerable<EvaluationContext>, CancellationToken) is invoked. |
| ScenarioRunResultExtensions |
Extension methods for ScenarioRunResult. |
Interfaces
| IEvaluationReportWriter |
Generates a report containing all the EvaluationMetrics present in the supplied ScenarioRunResults. |
| IEvaluationResponseCacheProvider |
Provides a way to get the IDistributedCache that caches the AI responses associated with a particular ScenarioRun. |
| IEvaluationResultStore |
Represents a store for ScenarioRunResults. |
