CanaryEvaluation
AgentPrism.Abstractions.dllRepresents the result of evaluating a canary policy against the current results of the canary and control variants.
public sealed record CanaryEvaluation : IEquatable<CanaryEvaluation>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”Inherited Members
Section titled “Inherited Members”object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”This type is not persisted. Each
GET /api/experiments/{name}/canary call runs CanaryEvaluator
again with current ExperimentVariantResult data. Canary run
results already accumulate from the start of the experiment; an evaluation
history table would store the same information twice.
Constructors
Section titled “Constructors”CanaryEvaluation()
Section titled “ CanaryEvaluation()”public CanaryEvaluation()Properties
Section titled “Properties”Canary
Section titled “ Canary”Gets the current canary variant results. Returns null when no runs exist.
public ExperimentVariantResult? Canary { get; init; }Property Value
Section titled “Property Value”Control
Section titled “ Control”Gets the current control variant results. Returns null when no runs exist.
public ExperimentVariantResult? Control { get; init; }Property Value
Section titled “Property Value”Decision
Section titled “ Decision”Gets the evaluation outcome.
public required CanaryDecisionKind Decision { get; init; }Property Value
Section titled “Property Value”EvaluatedAt
Section titled “ EvaluatedAt”Gets the UTC time when the evaluation occurred.
public required DateTimeOffset EvaluatedAt { get; init; }Property Value
Section titled “Property Value”Reason
Section titled “ Reason”Gets the human-readable reason for the decision.
public required string Reason { get; init; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”Equals(object?)
Section titled “ Equals(object?)”public override bool Equals(object? obj)Parameters
Section titled “Parameters”obj object?
Returns
Section titled “Returns”Equals(CanaryEvaluation?)
Section titled “ Equals(CanaryEvaluation?)”public bool Equals(CanaryEvaluation? other)Parameters
Section titled “Parameters”other CanaryEvaluation?
Returns
Section titled “Returns”GetHashCode()
Section titled “ GetHashCode()”public override int GetHashCode()Returns
Section titled “Returns”ToString()
Section titled “ ToString()”public override string ToString()Returns
Section titled “Returns”Operators
Section titled “Operators”operator ==(CanaryEvaluation?, CanaryEvaluation?)
Section titled “ operator ==(CanaryEvaluation?, CanaryEvaluation?)”public static bool operator ==(CanaryEvaluation? left, CanaryEvaluation? right)Parameters
Section titled “Parameters”left CanaryEvaluation?
right CanaryEvaluation?
Returns
Section titled “Returns”operator !=(CanaryEvaluation?, CanaryEvaluation?)
Section titled “ operator !=(CanaryEvaluation?, CanaryEvaluation?)”public static bool operator !=(CanaryEvaluation? left, CanaryEvaluation? right)Parameters
Section titled “Parameters”left CanaryEvaluation?
right CanaryEvaluation?