Package org.kie.kogito.explainability.handlers

Class CounterfactualExplainerServiceHandler

java.lang.Object

org.kie.kogito.explainability.handlers.CounterfactualExplainerServiceHandler

All Implemented Interfaces:

LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>, org.kie.kogito.explainability.local.LocalExplainer<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult>

@ApplicationScoped
public class CounterfactualExplainerServiceHandler
extends Object
implements LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Constructor Summary

Constructors

Constructor	Description
CounterfactualExplainerServiceHandler(org.kie.kogito.explainability.local.counterfactual.CounterfactualExplainer explainer, PredictionProviderFactory predictionProviderFactory, Long kafkaMaxRecordAgeMilliSeconds)

Method Summary

Modifier and Type	Method	Description
BaseExplainabilityResult	createFailedResult(CounterfactualExplainabilityRequest request, Throwable throwable)	Creates a result containing the "failed" information for an explanation calculation.
BaseExplainabilityResult	createIntermediateResult(CounterfactualExplainabilityRequest request, org.kie.kogito.explainability.local.counterfactual.CounterfactualResult result)	Creates a result containing the "intermediate" information for an explanation calculation.
BaseExplainabilityResult	createSucceededResult(CounterfactualExplainabilityRequest request, org.kie.kogito.explainability.local.counterfactual.CounterfactualResult result)	Creates a result containing the "success" information for an explanation calculation.
CompletableFuture<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult>	explainAsync(org.kie.kogito.explainability.model.Prediction prediction, org.kie.kogito.explainability.model.PredictionProvider predictionProvider, Consumer<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult> intermediateResultsConsumer)
org.kie.kogito.explainability.model.Prediction	getPrediction(CounterfactualExplainabilityRequest request)	Gets a Prediction object from the request for the LocalExplainer.
org.kie.kogito.explainability.model.PredictionProvider	getPredictionProvider(CounterfactualExplainabilityRequest request)	Gets a PredictionProvider object from the request for the LocalExplainer.
<T extends BaseExplainabilityRequest> boolean	supports(Class<T> type)	Checks whether an implementation supports a type of explanation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kie.kogito.explainability.local.LocalExplainer

explainAsync

Methods inherited from interface org.kie.kogito.explainability.handlers.LocalExplainerServiceHandler

explainAsyncWithResults

Constructor Details

CounterfactualExplainerServiceHandler

@Inject
public CounterfactualExplainerServiceHandler(org.kie.kogito.explainability.local.counterfactual.CounterfactualExplainer explainer,
 PredictionProviderFactory predictionProviderFactory,
 Long kafkaMaxRecordAgeMilliSeconds)

Method Details

supports

public <T extends BaseExplainabilityRequest>
boolean supports(Class<T> type)

Description copied from interface: LocalExplainerServiceHandler

Checks whether an implementation supports a type of explanation.

Specified by:

supports in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

type - The Trusty Service request type.

Returns:

true if the implementation supports the type of explanation.

getPredictionProvider

public org.kie.kogito.explainability.model.PredictionProvider getPredictionProvider(CounterfactualExplainabilityRequest request)

Description copied from interface: LocalExplainerServiceHandler

Gets a PredictionProvider object from the request for the LocalExplainer.

Specified by:

getPredictionProvider in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

request - The explanation request.

Returns:

A PredictionProvider object.

getPrediction

public org.kie.kogito.explainability.model.Prediction getPrediction(CounterfactualExplainabilityRequest request)

Description copied from interface: LocalExplainerServiceHandler

Gets a Prediction object from the request for the LocalExplainer. It should contain all the necessary information for the LocalExplainer to calculate an explanation.

Specified by:

getPrediction in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

request - The explanation request.

Returns:

A Prediction object containing all of the information necessary to calculate an explanation.

createSucceededResult

public BaseExplainabilityResult createSucceededResult(CounterfactualExplainabilityRequest request,
 org.kie.kogito.explainability.local.counterfactual.CounterfactualResult result)

Description copied from interface: LocalExplainerServiceHandler

Creates a result containing the "success" information for an explanation calculation.

Specified by:

createSucceededResult in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

request - The original request.

result - The result from the LocalExplainer calculation.

Returns:

createFailedResult

public BaseExplainabilityResult createFailedResult(CounterfactualExplainabilityRequest request,
 Throwable throwable)

Description copied from interface: LocalExplainerServiceHandler

Creates a result containing the "failed" information for an explanation calculation.

Specified by:

createFailedResult in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

request - The original request.

throwable - The exception thrown during calculation.

Returns:

createIntermediateResult

public BaseExplainabilityResult createIntermediateResult(CounterfactualExplainabilityRequest request,
 org.kie.kogito.explainability.local.counterfactual.CounterfactualResult result)

Description copied from interface: LocalExplainerServiceHandler

Creates a result containing the "intermediate" information for an explanation calculation.

Specified by:

createIntermediateResult in interface LocalExplainerServiceHandler<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult,CounterfactualExplainabilityRequest>

Parameters:

request - The original request.

result - The intermediate result from the LocalExplainer calculation.

Returns:

explainAsync

public CompletableFuture<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult> explainAsync(org.kie.kogito.explainability.model.Prediction prediction,
 org.kie.kogito.explainability.model.PredictionProvider predictionProvider,
 Consumer<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult> intermediateResultsConsumer)

Specified by:

explainAsync in interface org.kie.kogito.explainability.local.LocalExplainer<org.kie.kogito.explainability.local.counterfactual.CounterfactualResult>