ScenarioRunResult Constructors
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.
Overloads
| Name | Description |
|---|---|
| ScenarioRunResult(String, String, String, DateTime, IEnumerable<ChatMessage>, ChatResponse, EvaluationResult, ChatDetails, IEnumerable<String>) |
Initializes a new instance of the ScenarioRunResult class. |
| ScenarioRunResult(String, String, String, DateTime, IList<ChatMessage>, ChatResponse, EvaluationResult, ChatDetails, IList<String>, Nullable<Int32>) |
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. |
ScenarioRunResult(String, String, String, DateTime, IEnumerable<ChatMessage>, ChatResponse, EvaluationResult, ChatDetails, IEnumerable<String>)
- Source:
- ScenarioRunResult.cs
Initializes a new instance of the ScenarioRunResult class.
public ScenarioRunResult(string scenarioName, string iterationName, string executionName, DateTime creationTime, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatResponse modelResponse, Microsoft.Extensions.AI.Evaluation.EvaluationResult evaluationResult, Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails? chatDetails = default, System.Collections.Generic.IEnumerable<string>? tags = default);new Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResult : string * string * string * DateTime * seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatResponse * Microsoft.Extensions.AI.Evaluation.EvaluationResult * Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails * seq<string> -> Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResultPublic Sub New (scenarioName As String, iterationName As String, executionName As String, creationTime As DateTime, messages As IEnumerable(Of ChatMessage), modelResponse As ChatResponse, evaluationResult As EvaluationResult, Optional chatDetails As ChatDetails = Nothing, Optional tags As IEnumerable(Of String) = Nothing)Parameters
- scenarioName
- String
The ScenarioName.
- iterationName
- String
The IterationName.
- executionName
- String
The ExecutionName.
- creationTime
- DateTime
The time at which this ScenarioRunResult was created.
- messages
- IEnumerable<ChatMessage>
The conversation history including the request that produced the modelResponse being
evaluated.
- modelResponse
- ChatResponse
The response being evaluated.
- evaluationResult
- EvaluationResult
The EvaluationResult for the ScenarioRun corresponding to the ScenarioRunResult being constructed.
- chatDetails
- ChatDetails
An optional ChatDetails object that contains details related to all LLM chat
conversation turns involved in the execution of the the ScenarioRun corresponding to the
ScenarioRunResult being constructed. Can be null if none of the
IEvaluators invoked during the execution of the ScenarioRun use an LLM.
- tags
- IEnumerable<String>
An optional set of text tags applicable to this ScenarioRunResult.
Applies to
ScenarioRunResult(String, String, String, DateTime, IList<ChatMessage>, ChatResponse, EvaluationResult, ChatDetails, IList<String>, Nullable<Int32>)
- Source:
- ScenarioRunResult.cs
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.
[System.Text.Json.Serialization.JsonConstructor]
public ScenarioRunResult(string scenarioName, string iterationName, string executionName, DateTime creationTime, System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatResponse modelResponse, Microsoft.Extensions.AI.Evaluation.EvaluationResult evaluationResult, Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails? chatDetails = default, System.Collections.Generic.IList<string>? tags = default, int? formatVersion = default);[<System.Text.Json.Serialization.JsonConstructor>]
new Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResult : string * string * string * DateTime * System.Collections.Generic.IList<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatResponse * Microsoft.Extensions.AI.Evaluation.EvaluationResult * Microsoft.Extensions.AI.Evaluation.Reporting.ChatDetails * System.Collections.Generic.IList<string> * Nullable<int> -> Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResultPublic Sub New (scenarioName As String, iterationName As String, executionName As String, creationTime As DateTime, messages As IList(Of ChatMessage), modelResponse As ChatResponse, evaluationResult As EvaluationResult, Optional chatDetails As ChatDetails = Nothing, Optional tags As IList(Of String) = Nothing, Optional formatVersion As Nullable(Of Integer) = Nothing)Parameters
- scenarioName
- String
The ScenarioName.
- iterationName
- String
The IterationName.
- executionName
- String
The ExecutionName.
- creationTime
- DateTime
The time at which this ScenarioRunResult was created.
- messages
- IList<ChatMessage>
The conversation history including the request that produced the modelResponse being evaluated.
- modelResponse
- ChatResponse
The response being evaluated.
- evaluationResult
- EvaluationResult
The EvaluationResult for the ScenarioRun corresponding to the ScenarioRunResult being constructed.
- chatDetails
- ChatDetails
An optional ChatDetails object that contains details related to all LLM chat conversation
turns involved in the execution of the the ScenarioRun corresponding to the
ScenarioRunResult being constructed. Can be null if none of the
IEvaluators invoked during the execution of the ScenarioRun use an LLM.
An optional set of text tags applicable to this ScenarioRunResult.
The version of the format used to persist the current ScenarioRunResult.
- Attributes
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.
