software.amazon.awssdk.services.transcribestreaming.model

Class Entity

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.Entity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Entity.Builder,Entity>

@Generated(value="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 and Description
static interface	Entity.Builder

Method Summary

Modifier and Type	Method and Description
static Entity.Builder	builder()
String	category() The category of information identified.
Double	confidence() The confidence score associated with the identified PII entity in your audio.
String	content() The word or words identified as PII.
Double	endTime() The end time, in milliseconds, of the utterance that was identified as PII.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Entity.Builder>	serializableBuilderClass()
Double	startTime() The start time, in milliseconds, of the utterance that was identified as PII.
Entity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() 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, 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()

Specified by:

toBuilder in interface ToCopyableBuilder<Entity.Builder,Entity>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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