Class CallAnalyticsEntity

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

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

See Also:

  • Method Details

    • beginOffsetMillis

      public final Long beginOffsetMillis()

      The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.

      Returns:
      The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.

    • endOffsetMillis

      public final Long endOffsetMillis()

      The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.

      Returns:
      The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.

    • category

      public final String category()

      The category of information identified. For example, PII.

      Returns:
      The category of information identified. For example, 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 that represent the identified entity.

      Returns:
      The word or words that represent the identified entity.

    • confidence

      public final Double confidence()

      The confidence score associated with the identification of an entity in your transcript.

      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 identification of an entity in your transcript.

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

    • builder

      public static CallAnalyticsEntity.Builder builder()

    • serializableBuilderClass

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