ExperimentSinkResult

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentSinkResult Class

Describes one final result sink's publication outcome independently from run quality.

public sealed record ExperimentSinkResult : System.IEquatable<NexusLabs.Foundry.Evaluation.Experiments.ExperimentSinkResult>

Inheritance System.Object 🡒 ExperimentSinkResult

Implements System.IEquatable<ExperimentSinkResult>

Properties

ExperimentSinkResult.Failure Property

Gets the structured publication failure, when present.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentFailure? Failure { get; }

Property Value

ExperimentFailure

ExperimentSinkResult.IsRequired Property

Gets a value indicating whether failure contributes to aggregate required-publication failure.

public bool IsRequired { get; }

Property Value

System.Boolean

ExperimentSinkResult.Name Property

Gets the unique result-sink name.

public string Name { get; }

Property Value

System.String

ExperimentSinkResult.Status Property

Gets the publication operation status.

public NexusLabs.Foundry.Evaluation.Experiments.ExperimentPublicationOperationStatus Status { get; }

Property Value

ExperimentPublicationOperationStatus

Methods

ExperimentSinkResult.Failed(string, bool, ExperimentFailure) Method

Creates a failed canonical result-sink publication result.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentSinkResult Failed(string name, bool isRequired, NexusLabs.Foundry.Evaluation.Experiments.ExperimentFailure failure);

Parameters

name System.String

The registered result-sink name.

isRequired System.Boolean

Whether publication failure is required.

failure ExperimentFailure

The structured result-sink publication failure.

Returns

ExperimentSinkResult
A failed canonical sink result.

Exceptions

System.ArgumentException
name is blank.

System.ArgumentNullException
failure is null.

System.InvalidOperationException
failure is not a non-retryable result-sink publication failure.

ExperimentSinkResult.NotAttempted(string, bool) Method

Creates a canonical result-sink publication result that was not attempted.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentSinkResult NotAttempted(string name, bool isRequired);

Parameters

name System.String

The registered result-sink name.

isRequired System.Boolean

Whether publication failure is required.

Returns

ExperimentSinkResult
A not-attempted canonical sink result.

Exceptions

System.ArgumentException
name is blank.

ExperimentSinkResult.Succeeded(string, bool) Method

Creates a successful canonical result-sink publication result.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentSinkResult Succeeded(string name, bool isRequired);

Parameters

name System.String

The registered result-sink name.

isRequired System.Boolean

Whether publication failure is required.

Returns

ExperimentSinkResult
A successful canonical sink result.

Exceptions

System.ArgumentException
name is blank.