Class Entity
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Entity.Builder
builder()
final String
category()
The category of information identified.final Double
The confidence score associated with the identified PII entity in your audio.final String
content()
The word or words identified as PII.final Double
endTime()
The end time, in milliseconds, of the utterance that was identified as PII.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends Entity.Builder> final Double
The start time, in milliseconds, of the utterance that was identified as PII.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The type of PII identified.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The category of information identified. The only category is
PII
.- Returns:
- The category of information identified. The only category is
PII
.
-
type
The type of PII identified. For example,
NAME
orCREDIT_DEBIT_NUMBER
.- Returns:
- The type of PII identified. For example,
NAME
orCREDIT_DEBIT_NUMBER
.
-
content
The word or words identified as PII.
- Returns:
- The word or words identified as PII.
-
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
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 interfaceToCopyableBuilder<Entity.Builder,
Entity> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-