Class SentimentResponse

java.lang.Object
software.amazon.awssdk.services.lexruntimev2.model.SentimentResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SentimentResponse.Builder,SentimentResponse>
@Generated("software.amazon.awssdk:codegen") public final class SentimentResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SentimentResponse.Builder,SentimentResponse>

Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.

For more information, see Determine Sentiment in the Amazon Comprehend developer guide.

See Also:

  • Method Details

    • sentiment

      public final SentimentType sentiment()

      The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.

      If the service returns an enum value that is not available in the current SDK version, sentiment will return SentimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sentimentAsString().

      Returns:
      The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.
      See Also:

    • sentimentAsString

      public final String sentimentAsString()

      The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.

      If the service returns an enum value that is not available in the current SDK version, sentiment will return SentimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sentimentAsString().

      Returns:
      The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.
      See Also:

    • sentimentScore

      public final SentimentScore sentimentScore()
      Returns the value of the SentimentScore property for this object.
      Returns:
      The value of the SentimentScore property for this object.

    • toBuilder

      public SentimentResponse.Builder 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 interface ToCopyableBuilder<SentimentResponse.Builder,SentimentResponse>
      Returns:
      a builder for type T

    • builder

      public static SentimentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SentimentResponse.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.