Package software.amazon.awssdk.services.lexruntimev2.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SentimentResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SentimentResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SentimentType	sentiment()	The overall sentiment expressed in the user's response.
String	sentimentAsString()	The overall sentiment expressed in the user's response.
SentimentScore	sentimentScore()	Returns the value of the SentimentScore property for this object.
static Class<? extends SentimentResponse.Builder>	serializableBuilderClass()
SentimentResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SentimentType

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:

SentimentType

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

Specified by:

toBuilder in interface ToCopyableBuilder<SentimentResponse.Builder,SentimentResponse>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo