Package software.amazon.awssdk.services.comprehend.model

Class TargetedSentimentMention

java.lang.Object

software.amazon.awssdk.services.comprehend.model.TargetedSentimentMention

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TargetedSentimentMention.Builder,TargetedSentimentMention>

@Generated("software.amazon.awssdk:codegen")
public final class TargetedSentimentMention
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TargetedSentimentMention.Builder,TargetedSentimentMention>

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetedSentimentMention.Builder

Method Summary

Modifier and Type	Method	Description
Integer	beginOffset()	The offset into the document text where the mention begins.
static TargetedSentimentMention.Builder	builder()
Integer	endOffset()	The offset into the document text where the mention ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Float	groupScore()	The confidence that all the entities mentioned in the group relate to the same entity.
int	hashCode()
MentionSentiment	mentionSentiment()	Contains the sentiment and sentiment score for the mention.
Float	score()	Model confidence that the entity is relevant.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetedSentimentMention.Builder>	serializableBuilderClass()
String	text()	The text in the document that identifies the entity.
TargetedSentimentMention.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TargetedSentimentEntityType	type()	The type of the entity.
String	typeAsString()	The type of the entity.

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

score

public final Float score()

Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

Returns:

Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

groupScore

public final Float groupScore()

The confidence that all the entities mentioned in the group relate to the same entity.

Returns:

The confidence that all the entities mentioned in the group relate to the same entity.

text

public final String text()

The text in the document that identifies the entity.

Returns:

The text in the document that identifies the entity.

type

public final TargetedSentimentEntityType type()

The type of the entity. Amazon Comprehend supports a variety of entity types.

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

Returns:

The type of the entity. Amazon Comprehend supports a variety of entity types.

See Also:

TargetedSentimentEntityType

typeAsString

public final String typeAsString()

The type of the entity. Amazon Comprehend supports a variety of entity types.

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

Returns:

The type of the entity. Amazon Comprehend supports a variety of entity types.

See Also:

TargetedSentimentEntityType

mentionSentiment

public final MentionSentiment mentionSentiment()

Contains the sentiment and sentiment score for the mention.

Returns:

Contains the sentiment and sentiment score for the mention.

beginOffset

public final Integer beginOffset()

The offset into the document text where the mention begins.

Returns:

The offset into the document text where the mention begins.

endOffset

public final Integer endOffset()

The offset into the document text where the mention ends.

Returns:

The offset into the document text where the mention ends.

toBuilder

public TargetedSentimentMention.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetedSentimentMention.Builder,TargetedSentimentMention>

builder

public static TargetedSentimentMention.Builder builder()

serializableBuilderClass

public static Class<? extends TargetedSentimentMention.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