Package org.kie.kogito.explainability.api

Class CounterfactualExplainabilityResult

java.lang.Object

org.kie.kogito.explainability.api.BaseExplainabilityResult

org.kie.kogito.explainability.api.CounterfactualExplainabilityResult

public class CounterfactualExplainabilityResult
extends BaseExplainabilityResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CounterfactualExplainabilityResult.Stage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNTERFACTUAL_ID_FIELD
static final String	COUNTERFACTUAL_SEQUENCE_ID_FIELD
static final String	COUNTERFACTUAL_SOLUTION_ID_FIELD
static final String	EXPLAINABILITY_TYPE_NAME
static final String	INPUTS_FIELD
static final String	IS_VALID_FIELD
static final String	OUTPUTS_FIELD
static final String	STAGE_FIELD

Fields inherited from class org.kie.kogito.explainability.api.BaseExplainabilityResult

EXECUTION_ID_FIELD, EXPLAINABILITY_TYPE_FIELD, STATUS_DETAILS_FIELD, STATUS_FIELD

Constructor Summary

Constructors

Constructor	Description
CounterfactualExplainabilityResult()
CounterfactualExplainabilityResult(@NotNull String executionId, @NotNull String counterfactualId, @NotNull String solutionId, @NotNull Long sequenceId, @NotNull ExplainabilityStatus status, String statusDetails, @NotNull Boolean isValid, @NotNull CounterfactualExplainabilityResult.Stage stage, @NotNull Collection<NamedTypedValue> inputs, @NotNull Collection<NamedTypedValue> outputs)

Method Summary

Modifier and Type	Method	Description
static CounterfactualExplainabilityResult	buildFailed(String executionId, String counterfactualId, String statusDetails)
static CounterfactualExplainabilityResult	buildSucceeded(String executionId, String counterfactualId, String solutionId, Long sequenceId, Boolean isValid, CounterfactualExplainabilityResult.Stage stage, Collection<NamedTypedValue> inputs, Collection<NamedTypedValue> outputs)
String	getCounterfactualId()
Collection<NamedTypedValue>	getInputs()
Collection<NamedTypedValue>	getOutputs()
Long	getSequenceId()
String	getSolutionId()
CounterfactualExplainabilityResult.Stage	getStage()
Boolean	isValid()

Methods inherited from class org.kie.kogito.explainability.api.BaseExplainabilityResult

getExecutionId, getStatus, getStatusDetails

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXPLAINABILITY_TYPE_NAME

public static final String EXPLAINABILITY_TYPE_NAME

See Also:

• Constant Field Values

COUNTERFACTUAL_ID_FIELD

public static final String COUNTERFACTUAL_ID_FIELD

See Also:

• Constant Field Values

COUNTERFACTUAL_SOLUTION_ID_FIELD

public static final String COUNTERFACTUAL_SOLUTION_ID_FIELD

See Also:

• Constant Field Values

COUNTERFACTUAL_SEQUENCE_ID_FIELD

public static final String COUNTERFACTUAL_SEQUENCE_ID_FIELD

See Also:

• Constant Field Values

IS_VALID_FIELD

public static final String IS_VALID_FIELD

See Also:

• Constant Field Values

STAGE_FIELD

public static final String STAGE_FIELD

See Also:

• Constant Field Values

INPUTS_FIELD

public static final String INPUTS_FIELD

See Also:

• Constant Field Values

OUTPUTS_FIELD

public static final String OUTPUTS_FIELD

See Also:

• Constant Field Values

Constructor Details

CounterfactualExplainabilityResult

public CounterfactualExplainabilityResult()

CounterfactualExplainabilityResult

public CounterfactualExplainabilityResult(@NotNull
 @NotNull String executionId,
 @NotNull
 @NotNull String counterfactualId,
 @NotNull
 @NotNull String solutionId,
 @NotNull
 @NotNull Long sequenceId,
 @NotNull
 @NotNull ExplainabilityStatus status,
 String statusDetails,
 @NotNull
 @NotNull Boolean isValid,
 @NotNull
 @NotNull CounterfactualExplainabilityResult.Stage stage,
 @NotNull
 @NotNull Collection<NamedTypedValue> inputs,
 @NotNull
 @NotNull Collection<NamedTypedValue> outputs)

Method Details

buildSucceeded

public static CounterfactualExplainabilityResult buildSucceeded(String executionId,
 String counterfactualId,
 String solutionId,
 Long sequenceId,
 Boolean isValid,
 CounterfactualExplainabilityResult.Stage stage,
 Collection<NamedTypedValue> inputs,
 Collection<NamedTypedValue> outputs)

buildFailed

public static CounterfactualExplainabilityResult buildFailed(String executionId,
 String counterfactualId,
 String statusDetails)

getCounterfactualId

public String getCounterfactualId()

getSolutionId

public String getSolutionId()

getSequenceId

public Long getSequenceId()

isValid

public Boolean isValid()

getStage

public CounterfactualExplainabilityResult.Stage getStage()

getInputs

public Collection<NamedTypedValue> getInputs()

getOutputs

public Collection<NamedTypedValue> getOutputs()