Prediction (AWS SDK for Android - Amazon Machine Learning 2.2.6 API)

java.lang.Object
- com.amazonaws.services.machinelearning.model.Prediction

All Implemented Interfaces:

Serializable
```
public class Prediction
extends Object
implements Serializable
```
The output from a Predict operation:
- Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD
- PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.
- PredictedScores - Contains the raw classification score corresponding to each label.
- PredictedValue - Present for a REGRESSION MLModel request.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Prediction()

Constructors
Constructor and Description
`Prediction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Prediction`	`addDetailsEntry(String key, String value)` Provides any additional details regarding the prediction.
`Prediction`	`addPredictedScoresEntry(String key, Float value)` Provides the raw classification score corresponding to each label.
`Prediction`	`clearDetailsEntries()` Removes all the entries added into Details.
`Prediction`	`clearPredictedScoresEntries()` Removes all the entries added into PredictedScores.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getDetails()` Provides any additional details regarding the prediction.
`String`	`getPredictedLabel()` The prediction label for either a BINARY or MULTICLASS `MLModel`.
`Map<String,Float>`	`getPredictedScores()` Provides the raw classification score corresponding to each label.
`Float`	`getPredictedValue()` The prediction value for REGRESSION `MLModel`.
`int`	`hashCode()`
`void`	`setDetails(Map<String,String> details)` Provides any additional details regarding the prediction.
`void`	`setPredictedLabel(String predictedLabel)` The prediction label for either a BINARY or MULTICLASS `MLModel`.
`void`	`setPredictedScores(Map<String,Float> predictedScores)` Provides the raw classification score corresponding to each label.
`void`	`setPredictedValue(Float predictedValue)` The prediction value for REGRESSION `MLModel`.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Prediction`	`withDetails(Map<String,String> details)` Provides any additional details regarding the prediction.
`Prediction`	`withPredictedLabel(String predictedLabel)` The prediction label for either a BINARY or MULTICLASS `MLModel`.
`Prediction`	`withPredictedScores(Map<String,Float> predictedScores)` Provides the raw classification score corresponding to each label.
`Prediction`	`withPredictedValue(Float predictedValue)` The prediction value for REGRESSION `MLModel`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Prediction
```
public Prediction()
```
- Method Detail
  - getPredictedLabel
```
public String getPredictedLabel()
```
    The prediction label for either a BINARY or MULTICLASS MLModel.
    Constraints:
    Length: 1 -
    
    Returns:
    
    The prediction label for either a BINARY or MULTICLASS MLModel.
  - setPredictedLabel
```
public void setPredictedLabel(String predictedLabel)
```
    The prediction label for either a BINARY or MULTICLASS MLModel.
    Constraints:
    Length: 1 -
    
    Parameters:
    
    predictedLabel - The prediction label for either a BINARY or MULTICLASS MLModel.
  - withPredictedLabel
```
public Prediction withPredictedLabel(String predictedLabel)
```
    The prediction label for either a BINARY or MULTICLASS MLModel.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    
    predictedLabel - The prediction label for either a BINARY or MULTICLASS MLModel.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPredictedValue
```
public Float getPredictedValue()
```
    The prediction value for REGRESSION MLModel.
    
    Returns:
    
    The prediction value for REGRESSION MLModel.
  - setPredictedValue
```
public void setPredictedValue(Float predictedValue)
```
    The prediction value for REGRESSION MLModel.
    
    Parameters:
    
    predictedValue - The prediction value for REGRESSION MLModel.
  - withPredictedValue
```
public Prediction withPredictedValue(Float predictedValue)
```
    The prediction value for REGRESSION MLModel.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    predictedValue - The prediction value for REGRESSION MLModel.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPredictedScores
```
public Map<String,Float> getPredictedScores()
```
    Provides the raw classification score corresponding to each label.
    
    Returns:
    
    Provides the raw classification score corresponding to each label.
  - setPredictedScores
```
public void setPredictedScores(Map<String,Float> predictedScores)
```
    Provides the raw classification score corresponding to each label.
    
    Parameters:
    
    predictedScores - Provides the raw classification score corresponding to each label.
  - withPredictedScores
```
public Prediction withPredictedScores(Map<String,Float> predictedScores)
```
    Provides the raw classification score corresponding to each label.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    predictedScores - Provides the raw classification score corresponding to each label.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addPredictedScoresEntry
```
public Prediction addPredictedScoresEntry(String key,
                                          Float value)
```
    Provides the raw classification score corresponding to each label.
    The method adds a new key-value pair into PredictedScores parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into PredictedScores.
    
    value - The corresponding value of the entry to be added into PredictedScores.
  - clearPredictedScoresEntries
```
public Prediction clearPredictedScoresEntries()
```
    Removes all the entries added into PredictedScores.
    Returns a reference to this object so that method calls can be chained together.
  - getDetails
```
public Map<String,String> getDetails()
```
    Provides any additional details regarding the prediction.
    
    Returns:
    
    Provides any additional details regarding the prediction.
  - setDetails
```
public void setDetails(Map<String,String> details)
```
    Provides any additional details regarding the prediction.
    
    Parameters:
    
    details - Provides any additional details regarding the prediction.
  - withDetails
```
public Prediction withDetails(Map<String,String> details)
```
    Provides any additional details regarding the prediction.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    details - Provides any additional details regarding the prediction.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addDetailsEntry
```
public Prediction addDetailsEntry(String key,
                                  String value)
```
    Provides any additional details regarding the prediction.
    The method adds a new key-value pair into Details parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Details.
    
    value - The corresponding value of the entry to be added into Details.
  - clearDetailsEntries
```
public Prediction clearDetailsEntries()
```
    Removes all the entries added into Details.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Prediction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Prediction

Method Detail

getPredictedLabel

setPredictedLabel

withPredictedLabel

getPredictedValue

setPredictedValue

withPredictedValue

getPredictedScores

setPredictedScores

withPredictedScores

addPredictedScoresEntry

clearPredictedScoresEntries

getDetails

setDetails

withDetails

addDetailsEntry

clearDetailsEntries

toString

hashCode

equals