ScenarioRunResult Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI.Evaluation.Reporting

Assembly:: Microsoft.Extensions.AI.Evaluation.Reporting.dll

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

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.

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)	Creates a new ScenarioRunResult instance.
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	The time at which this ScenarioRunResult was created.
EvaluationResult	The EvaluationResult for the ScenarioRun corresponding to this ScenarioRunResult.
ExecutionName	The ExecutionName.
IterationName	The IterationName.
Messages	The conversation history including the request that produced the ModelResponse being evaluated in this ScenarioRunResult.
ModelResponse	The response being evaluated in this ScenarioRunResult.
ScenarioName	The ScenarioName.

Methods

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)

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.

Applies to

Jaa