Class Prediction

    • Method Detail

      • predictedLabel

        public final String predictedLabel()

        The prediction label for either a BINARY or MULTICLASS MLModel.

        Returns:
        The prediction label for either a BINARY or MULTICLASS MLModel.
      • predictedValue

        public final Float 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 the isEmpty() 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

        public final Map<String,​Float> 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

        public final Map<DetailsAttributes,​String> 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 the isEmpty() 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

        public final Map<String,​String> 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String 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.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)