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
| 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. |
ScenarioRunResult(String, String, String, DateTime, IEnumerable<ChatMessage>, ChatMessage, EvaluationResult)
Creates a new ScenarioRunResult instance.
public:
ScenarioRunResult(System::String ^ scenarioName, System::String ^ iterationName, System::String ^ executionName, DateTime creationTime, System::Collections::Generic::IEnumerable<Microsoft::Extensions::AI::ChatMessage ^> ^ messages, Microsoft::Extensions::AI::ChatMessage ^ modelResponse, Microsoft::Extensions::AI::Evaluation::EvaluationResult ^ evaluationResult);public ScenarioRunResult (string scenarioName, string iterationName, string executionName, DateTime creationTime, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatMessage modelResponse, Microsoft.Extensions.AI.Evaluation.EvaluationResult evaluationResult);new Microsoft.Extensions.AI.Evaluation.Reporting.ScenarioRunResult : string * string * string * DateTime * seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatMessage * Microsoft.Extensions.AI.Evaluation.EvaluationResult -> 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 ChatMessage, evaluationResult As EvaluationResult)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
- ChatMessage
The response being evaluated.
- evaluationResult
- EvaluationResult
The EvaluationResult for the ScenarioRun corresponding to the ScenarioRunResult being constructed.
Applies to
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.
public:
ScenarioRunResult(System::String ^ scenarioName, System::String ^ iterationName, System::String ^ executionName, DateTime creationTime, System::Collections::Generic::IList<Microsoft::Extensions::AI::ChatMessage ^> ^ messages, Microsoft::Extensions::AI::ChatMessage ^ modelResponse, Microsoft::Extensions::AI::Evaluation::EvaluationResult ^ evaluationResult);[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.ChatMessage modelResponse, Microsoft.Extensions.AI.Evaluation.EvaluationResult evaluationResult);[<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.ChatMessage * Microsoft.Extensions.AI.Evaluation.EvaluationResult -> 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 ChatMessage, evaluationResult As EvaluationResult)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
- ChatMessage
The response being evaluated.
- evaluationResult
- EvaluationResult
The EvaluationResult for the ScenarioRun corresponding to the ScenarioRunResult being constructed.
- 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.
