Package org.kie.kogito.explainability.api

Class CounterfactualExplainabilityRequest

java.lang.Object

org.kie.kogito.explainability.api.BaseExplainabilityRequest

org.kie.kogito.explainability.api.CounterfactualExplainabilityRequest

public class CounterfactualExplainabilityRequest
extends BaseExplainabilityRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNTERFACTUAL_GOALS_FIELD
static final String	COUNTERFACTUAL_ID_FIELD
static final String	COUNTERFACTUAL_ORIGINAL_INPUTS_FIELD
static final String	COUNTERFACTUAL_SEARCH_DOMAINS_FIELD
static final String	EXPLAINABILITY_TYPE_NAME
static final String	MAX_RUNNING_TIME_SECONDS_FIELD

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

EXECUTION_ID_FIELD, EXPLAINABILITY_TYPE_FIELD, MODEL_IDENTIFIER_FIELD, SERVICE_URL_FIELD

Constructor Summary

Constructors

Constructor	Description
CounterfactualExplainabilityRequest()
CounterfactualExplainabilityRequest(@NotNull String executionId, @NotBlank String serviceUrl, @NotNull ModelIdentifier modelIdentifier, @NotNull String counterfactualId, @NotNull Collection<NamedTypedValue> originalInputs, @NotNull Collection<NamedTypedValue> goals, @NotNull Collection<CounterfactualSearchDomain> searchDomains, Long maxRunningTimeSeconds)

Method Summary

Modifier and Type	Method	Description
String	getCounterfactualId()
Collection<NamedTypedValue>	getGoals()
Long	getMaxRunningTimeSeconds()
Collection<NamedTypedValue>	getOriginalInputs()
Collection<CounterfactualSearchDomain>	getSearchDomains()

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

getExecutionId, getModelIdentifier, getServiceUrl

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_ORIGINAL_INPUTS_FIELD

public static final String COUNTERFACTUAL_ORIGINAL_INPUTS_FIELD

See Also:

• Constant Field Values

COUNTERFACTUAL_GOALS_FIELD

public static final String COUNTERFACTUAL_GOALS_FIELD

See Also:

• Constant Field Values

COUNTERFACTUAL_SEARCH_DOMAINS_FIELD

public static final String COUNTERFACTUAL_SEARCH_DOMAINS_FIELD

See Also:

• Constant Field Values

MAX_RUNNING_TIME_SECONDS_FIELD

public static final String MAX_RUNNING_TIME_SECONDS_FIELD

See Also:

• Constant Field Values

Constructor Details

CounterfactualExplainabilityRequest

public CounterfactualExplainabilityRequest()

CounterfactualExplainabilityRequest

public CounterfactualExplainabilityRequest(@NotNull
 @NotNull String executionId,
 @NotBlank
 @NotBlank String serviceUrl,
 @NotNull
 @NotNull ModelIdentifier modelIdentifier,
 @NotNull
 @NotNull String counterfactualId,
 @NotNull
 @NotNull Collection<NamedTypedValue> originalInputs,
 @NotNull
 @NotNull Collection<NamedTypedValue> goals,
 @NotNull
 @NotNull Collection<CounterfactualSearchDomain> searchDomains,
 Long maxRunningTimeSeconds)

Method Details

getCounterfactualId

public String getCounterfactualId()

getOriginalInputs

public Collection<NamedTypedValue> getOriginalInputs()

getGoals

public Collection<NamedTypedValue> getGoals()

getSearchDomains

public Collection<CounterfactualSearchDomain> getSearchDomains()

getMaxRunningTimeSeconds

public Long getMaxRunningTimeSeconds()