ExperimentItemPublicationOperationResult

NexusLabs.Foundry.Evaluation

NexusLabs.Foundry.Evaluation.Experiments

ExperimentItemPublicationOperationResult Class

Describes item-scope publication work before the runner applies registered provider identity.

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

Inheritance System.Object 🡒 ExperimentItemPublicationOperationResult

Implements System.IEquatable<ExperimentItemPublicationOperationResult>

Properties

ExperimentItemPublicationOperationResult.Correlations Property

Gets the snapshotted provider correlations produced by the operation.

public System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemCorrelation> Correlations { get; }

Property Value

System.Collections.Generic.IReadOnlyList<ExperimentItemCorrelation>

ExperimentItemPublicationOperationResult.Failure Property

Gets the structured publication failure, when the operation failed.

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

Property Value

ExperimentFailure

ExperimentItemPublicationOperationResult.Status Property

Gets the publication operation status.

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

Property Value

ExperimentPublicationOperationStatus

Methods

ExperimentItemPublicationOperationResult.Failed(IReadOnlyList<ExperimentItemCorrelation>, ExperimentFailure) Method

Creates a failed item publication operation result.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemPublicationOperationResult Failed(System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemCorrelation> correlations, NexusLabs.Foundry.Evaluation.Experiments.ExperimentFailure failure);

Parameters

correlations System.Collections.Generic.IReadOnlyList<ExperimentItemCorrelation>

The provider correlations available for the operation.

failure ExperimentFailure

The structured publication failure.

Returns

ExperimentItemPublicationOperationResult
A failed operation result containing a snapshot of the correlations.

Exceptions

System.ArgumentNullException
correlations, one of its elements, or failure is null.

ExperimentItemPublicationOperationResult.NotAttempted(IReadOnlyList<ExperimentItemCorrelation>) Method

Creates an item publication operation result that was not attempted.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemPublicationOperationResult NotAttempted(System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemCorrelation> correlations);

Parameters

correlations System.Collections.Generic.IReadOnlyList<ExperimentItemCorrelation>

The provider correlations available for the operation.

Returns

ExperimentItemPublicationOperationResult
A not-attempted operation result containing a snapshot of the correlations.

Exceptions

System.ArgumentNullException
correlations or one of its elements is null.

ExperimentItemPublicationOperationResult.Succeeded(IReadOnlyList<ExperimentItemCorrelation>) Method

Creates a successful item publication operation result.

public static NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemPublicationOperationResult Succeeded(System.Collections.Generic.IReadOnlyList<NexusLabs.Foundry.Evaluation.Experiments.ExperimentItemCorrelation> correlations);

Parameters

correlations System.Collections.Generic.IReadOnlyList<ExperimentItemCorrelation>

The provider correlations produced by the operation.

Returns

ExperimentItemPublicationOperationResult
A successful operation result containing a snapshot of the correlations.

Exceptions

System.ArgumentNullException
correlations or one of its elements is null.