ScenarioRunResult 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 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>, ChatMessage, IEnumerable<EvaluationContext>, CancellationToken) is invoked.

public ref class ScenarioRunResult sealed

public sealed class ScenarioRunResult

type ScenarioRunResult = class

Public NotInheritable Class ScenarioRunResult

Inheritance

Object

ScenarioRunResult

Remarks

Each execution of an evaluation run is assigned a unique ExecutionName. A single such evaluation run can contain evaluations for multiple scenarios each with a unique ScenarioName. The execution of each such scenario in turn can include multiple iterations each with a unique IterationName.

Constructors

ScenarioRunResult(String, String, String, DateTime, IEnumerable<ChatMessage>, ChatMessage, EvaluationResult)	Initializes a new instance of the ScenarioRunResult class.
ScenarioRunResult(String, String, String, DateTime, IList<ChatMessage>, ChatMessage, EvaluationResult)	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>, ChatMessage, IEnumerable<EvaluationContext>, CancellationToken) is invoked.

Properties

CreationTime	Gets or sets the time at which this ScenarioRunResult was created.
EvaluationResult	Gets or sets the EvaluationResult for the ScenarioRun corresponding to this ScenarioRunResult.
ExecutionName	Gets or sets the ExecutionName.
IterationName	Gets or sets the IterationName.
Messages	Gets or sets the conversation history including the request that produced the ModelResponse being evaluated in this ScenarioRunResult.
ModelResponse	Gets or sets the response being evaluated in this ScenarioRunResult.
ScenarioName	Gets or sets the ScenarioName.

Extension Methods

ContainsDiagnostics(ScenarioRunResult, Func<EvaluationDiagnostic,Boolean>)

Returns true if any EvaluationMetric contained in the supplied result contains an EvaluationDiagnostic matching the supplied predicate; false otherwise.