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

Class MedicalEntity

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.MedicalEntity

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class MedicalEntity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MedicalEntity.Builder,MedicalEntity>

Contains entities identified as personal health information (PHI) 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 interface	MedicalEntity.Builder

Method Summary

Modifier and Type	Method	Description
static MedicalEntity.Builder	builder()
String	category()	The category of information identified.
Double	confidence()	The confidence score associated with the identified PHI entity in your audio.
String	content()	The word or words identified as PHI.
Double	endTime()	The end time, in seconds, of the utterance that was identified as PHI.
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 MedicalEntity.Builder>	serializableBuilderClass()
Double	startTime()	The start time, in seconds, of the utterance that was identified as PHI.
MedicalEntity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 seconds, of the utterance that was identified as PHI.

Returns:

The start time, in seconds, of the utterance that was identified as PHI.

endTime

public final Double endTime()

The end time, in seconds, of the utterance that was identified as PHI.

Returns:

The end time, in seconds, of the utterance that was identified as PHI.

category

public final String category()

The category of information identified. The only category is PHI.

Returns:

The category of information identified. The only category is PHI.

content

public final String content()

The word or words identified as PHI.

Returns:

The word or words identified as PHI.

confidence

public final Double confidence()

The confidence score associated with the identified PHI 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 PHI 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 MedicalEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalEntity.Builder,MedicalEntity>

builder

public static MedicalEntity.Builder builder()

serializableBuilderClass

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