Class Entity

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.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>

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

See Also:

  • Method Details

    • startTime

      public final Double startTime()

      The start time, in milliseconds, of the utterance that was identified as PII.

      Returns:
      The start time, in milliseconds, of the utterance that was identified as PII.

    • endTime

      public final Double endTime()

      The end time, in milliseconds, of the utterance that was identified as PII.

      Returns:
      The end time, in milliseconds, of the utterance that was identified as PII.

    • category

      public final String category()

      The category of information identified. The only category is PII.

      Returns:
      The category of information identified. The only category is PII.

    • type

      public final String type()

      The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.

      Returns:
      The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.

    • content

      public final String content()

      The word or words identified as PII.

      Returns:
      The word or words identified as PII.

    • confidence

      public final Double confidence()

      The confidence score associated with the identified PII entity in your audio.

      Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

      Returns:
      The confidence score associated with the identified PII entity in your audio.

      Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

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