Package software.amazon.awssdk.services.transcribestreaming.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CallAnalyticsEntity.Builder

Method Summary

Modifier and Type	Method	Description
Long	beginOffsetMillis()	The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.
static CallAnalyticsEntity.Builder	builder()
String	category()	The category of information identified.
Double	confidence()	The confidence score associated with the identification of an entity in your transcript.
String	content()	The word or words that represent the identified entity.
Long	endOffsetMillis()	The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CallAnalyticsEntity.Builder>	serializableBuilderClass()
CallAnalyticsEntity.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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CallAnalyticsEntity.Builder,CallAnalyticsEntity>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo