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

Class MedicalScribeTranscriptItem

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeTranscriptItem

All Implemented Interfaces:

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

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

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MedicalScribeTranscriptItem.Builder

Method Summary

Modifier and Type	Method	Description
Double	beginAudioTime()	The start time, in milliseconds, of the transcribed item.
static MedicalScribeTranscriptItem.Builder	builder()
Double	confidence()	The confidence score associated with a word or phrase in your transcript.
String	content()	The word, phrase or punctuation mark that was transcribed.
Double	endAudioTime()	The end time, in milliseconds, of the transcribed item.
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 MedicalScribeTranscriptItem.Builder>	serializableBuilderClass()
MedicalScribeTranscriptItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MedicalScribeTranscriptItemType	type()	The type of item identified.
String	typeAsString()	The type of item identified.
Boolean	vocabularyFilterMatch()	Indicates whether the specified item matches a word in the vocabulary filter included in your configuration event.

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

beginAudioTime

public final Double beginAudioTime()

The start time, in milliseconds, of the transcribed item.

Returns:

The start time, in milliseconds, of the transcribed item.

endAudioTime

public final Double endAudioTime()

The end time, in milliseconds, of the transcribed item.

Returns:

The end time, in milliseconds, of the transcribed item.

type

public final MedicalScribeTranscriptItemType type()

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

If the service returns an enum value that is not available in the current SDK version, type will return MedicalScribeTranscriptItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

See Also:

MedicalScribeTranscriptItemType

typeAsString

public final String typeAsString()

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

If the service returns an enum value that is not available in the current SDK version, type will return MedicalScribeTranscriptItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

See Also:

MedicalScribeTranscriptItemType

confidence

public final Double confidence()

The confidence score associated with a word or phrase in your transcript.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.

Returns:

The confidence score associated with a word or phrase in your transcript.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.

content

public final String content()

The word, phrase or punctuation mark that was transcribed.

Returns:

The word, phrase or punctuation mark that was transcribed.

vocabularyFilterMatch

public final Boolean vocabularyFilterMatch()

Indicates whether the specified item matches a word in the vocabulary filter included in your configuration event. If true, there is a vocabulary filter match.

Returns:

Indicates whether the specified item matches a word in the vocabulary filter included in your configuration event. If true, there is a vocabulary filter match.

toBuilder

public MedicalScribeTranscriptItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeTranscriptItem.Builder,MedicalScribeTranscriptItem>

builder

public static MedicalScribeTranscriptItem.Builder builder()

serializableBuilderClass

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