BooleanMetric Class
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.
An EvaluationMetric containing a Boolean value that can be used to represent an outcome that can have one of two possible values (such as yes v/s no, or pass v/s fail).
public ref class BooleanMetric sealed : Microsoft::Extensions::AI::Evaluation::EvaluationMetric<Nullable<bool>>public sealed class BooleanMetric : Microsoft.Extensions.AI.Evaluation.EvaluationMetric<bool?>type BooleanMetric = class
inherit EvaluationMetric<Nullable<bool>>Public NotInheritable Class BooleanMetric
Inherits EvaluationMetric(Of Nullable(Of Boolean))- Inheritance
Constructors
| Name | Description |
|---|---|
| BooleanMetric(String, Nullable<Boolean>, String) |
An EvaluationMetric containing a Boolean value that can be used to represent an outcome that can have one of two possible values (such as yes v/s no, or pass v/s fail). |
Properties
| Name | Description |
|---|---|
| Context |
Gets or sets any EvaluationContexts that were considered by the IEvaluator as part of the evaluation that produced the current EvaluationMetric. (Inherited from EvaluationMetric) |
| Diagnostics |
Gets or sets a collection of zero or more EvaluationDiagnostics associated with the current EvaluationMetric. (Inherited from EvaluationMetric) |
| Interpretation |
Gets or sets an EvaluationMetricInterpretation that identifies whether the result of the evaluation represented by the current EvaluationMetric is considered good or bad, passed or failed etc. (Inherited from EvaluationMetric) |
| Metadata |
Gets or sets a collection of zero or more string metadata associated with the current EvaluationMetric. (Inherited from EvaluationMetric) |
| Name |
Gets or sets the name of the EvaluationMetric. (Inherited from EvaluationMetric) |
| Reason |
Gets or sets a string that can optionally be used to provide some commentary around the result represented by this EvaluationMetric. (Inherited from EvaluationMetric) |
| Value |
Gets or sets the value of the EvaluationMetric<T>. (Inherited from EvaluationMetric<T>) |
Extension Methods
| Name | Description |
|---|---|
| AddDiagnostics(EvaluationMetric, EvaluationDiagnostic[]) |
Adds the supplied EvaluationDiagnostics to the supplied EvaluationMetric's Diagnostics collection. |
| AddDiagnostics(EvaluationMetric, IEnumerable<EvaluationDiagnostic>) |
Adds the supplied EvaluationDiagnostics to the supplied EvaluationMetric's Diagnostics collection. |
| AddOrUpdateChatMetadata(EvaluationMetric, ChatResponse, Nullable<TimeSpan>) |
Adds or updates metadata available as part of the evaluation |
| AddOrUpdateContext(EvaluationMetric, EvaluationContext[]) |
Adds or updates the supplied |
| AddOrUpdateContext(EvaluationMetric, IEnumerable<EvaluationContext>) |
Adds or updates the supplied |
| AddOrUpdateDurationMetadata(EvaluationMetric, TimeSpan) |
Adds or updates metadata identifying the amount of time (in milliseconds) that it took to perform the
evaluation in the supplied |
| AddOrUpdateMetadata(EvaluationMetric, IDictionary<String,String>) |
Adds or updates the supplied |
| AddOrUpdateMetadata(EvaluationMetric, String, String) |
Adds or updates metadata with the specified |
| ContainsDiagnostics(EvaluationMetric, Func<EvaluationDiagnostic,Boolean>) |
Determines if the supplied |
