Class SentimentResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SentimentResponse.Builder
builder()
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 int
hashCode()
final SentimentType
The overall sentiment expressed in the user's response.final String
The overall sentiment expressed in the user's response.final SentimentScore
Returns the value of the SentimentScore property for this object.static Class
<? extends SentimentResponse.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
-
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 returnSentimentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsentimentAsString()
.- 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
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 returnSentimentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsentimentAsString()
.- 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
Returns the value of the SentimentScore property for this object.- Returns:
- The value of the SentimentScore 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<SentimentResponse.Builder,
SentimentResponse> - 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
-