Class Entity

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

Provides information about an entity.

See Also:

  • Method Details

    • score

      public final Float score()

      The level of confidence that Amazon Comprehend has in the accuracy of the detection.

      Returns:
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.

    • type

      public final EntityType type()

      The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

      For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

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

      Returns:
      The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

      For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

      See Also:

    • typeAsString

      public final String typeAsString()

      The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

      For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

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

      Returns:
      The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

      For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

      See Also:

    • text

      public final String text()

      The text of the entity.

      Returns:
      The text of the entity.

    • beginOffset

      public final Integer beginOffset()

      The zero-based offset from the beginning of the source text to the first character in the entity.

      This field is empty for non-text input.

      Returns:
      The zero-based offset from the beginning of the source text to the first character in the entity.

      This field is empty for non-text input.

    • endOffset

      public final Integer endOffset()

      The zero-based offset from the beginning of the source text to the last character in the entity.

      This field is empty for non-text input.

      Returns:
      The zero-based offset from the beginning of the source text to the last character in the entity.

      This field is empty for non-text input.

    • hasBlockReferences

      public final boolean hasBlockReferences()
      For responses, this returns true if the service returned a value for the BlockReferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockReferences

      public final List<BlockReference> blockReferences()

      A reference to each block for this entity. This field is empty for plain-text input.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockReferences() method.

      Returns:
      A reference to each block for this entity. This field is empty for plain-text input.

    • toBuilder

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

    • builder

      public static Entity.Builder builder()

    • serializableBuilderClass

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