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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEntity.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Entity.Builderbuilder()Stringcategory()The category of information identified.Doubleconfidence()The confidence score associated with the identified PII entity in your audio.Stringcontent()The word or words identified as PII.DoubleendTime()The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Entity.Builder>serializableBuilderClass()DoublestartTime()The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)Entity.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringtype()The type of PII identified.-
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
-
startTime
public final Double startTime()
The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)
- Returns:
- The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)
-
endTime
public final Double endTime()
The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)
- Returns:
- The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)
-
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,
NAMEorCREDIT_DEBIT_NUMBER.- Returns:
- The type of PII identified. For example,
NAMEorCREDIT_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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Entity.Builder,Entity>
-
builder
public static Entity.Builder builder()
-
serializableBuilderClass
public static Class<? extends Entity.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-