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:

  • Method Details

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

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

    • 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()
      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<TargetedSentimentMention.Builder,TargetedSentimentMention>
      Returns:
      a builder for type T

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