Class Prediction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Prediction.Builder,
Prediction>
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 aBINARY
orMULTICLASS
MLModel
request. -
PredictedScores
- Contains the raw classification score corresponding to each label. -
PredictedValue
- Present for aREGRESSION
MLModel
request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Prediction.Builder
builder()
final Map
<DetailsAttributes, String> details()
Returns the value of the Details property for this object.Returns the value of the Details property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Details property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PredictedScores property.final String
The prediction label for either aBINARY
orMULTICLASS
MLModel
.Returns the value of the PredictedScores property for this object.final Float
The prediction value forREGRESSION
MLModel
.static Class
<? extends Prediction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
predictedLabel
The prediction label for either a
BINARY
orMULTICLASS
MLModel
.- Returns:
- The prediction label for either a
BINARY
orMULTICLASS
MLModel
.
-
predictedValue
The prediction value for
REGRESSION
MLModel
.- Returns:
- The prediction value for
REGRESSION
MLModel
.
-
hasPredictedScores
public final boolean hasPredictedScores()For responses, this returns true if the service returned a value for the PredictedScores property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
predictedScores
Returns the value of the PredictedScores property for this object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPredictedScores()
method.- Returns:
- The value of the PredictedScores property for this object.
-
details
Returns the value of the Details property for this object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDetails()
method.- Returns:
- The value of the Details property for this object.
-
hasDetails
public final boolean hasDetails()For responses, this returns true if the service returned a value for the Details property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
detailsAsStrings
Returns the value of the Details property for this object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDetails()
method.- Returns:
- The value of the Details property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Prediction.Builder,
Prediction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-