Package org.kie.internal.task.api.prediction

## Class PredictionOutcome

- java.lang.Object
- - org.kie.internal.task.api.prediction.PredictionOutcome

-     public class PredictionOutcome
      extends Object

  Encapsulates results from a `PredictionService`.

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `PredictionOutcome()` | Creates an empty prediction.
    `PredictionOutcome​(double confidenceLevel, double confidenceThreshold, Map<String,​Object> data)` | Returns a prediction for a prediction service with the specified confidence level, confidence threshold and outcome.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `double` | `getConfidenceLevel()` |
    `double` | `getConfidenceThreshold()` |
    `Map<String,​Object>` | `getData()` |
    `boolean` | `isCertain()` | Returns true if a prediction has a confidence level above the specified threshold otherwise false
    `boolean` | `isPresent()` |

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PredictionOutcome

          public PredictionOutcome()

      Creates an empty prediction.

    - #### PredictionOutcome

          public PredictionOutcome​(double confidenceLevel,
                                   double confidenceThreshold,
                                   Map<String,​Object> data)

      Returns a prediction for a prediction service with the specified confidence level, confidence threshold and outcome.
      Parameters:
        `confidenceLevel` - Numerical value to quantify confidence level for this prediction
        `confidenceThreshold` - The threshold above which a prediction should be automatically accepted
        `data` - A map containing the outcome names and values (respectively as map keys and values)

  - ### Method Detail

    - #### isPresent

          public boolean isPresent()

    - #### isCertain

          public boolean isCertain()

      Returns true if a prediction has a confidence level above the specified threshold otherwise false

    - #### getConfidenceLevel

          public double getConfidenceLevel()

    - #### getConfidenceThreshold

          public double getConfidenceThreshold()

    - #### getData

          public Map<String,​Object> getData()