software.amazon.awssdk.services.transcribestreaming.model

Class MedicalResult

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.MedicalResult

All Implemented Interfaces:

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

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

The results of transcribing a portion of the input audio stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MedicalResult.Builder

Method Summary

Modifier and Type	Method and Description
List<MedicalAlternative>	alternatives() A list of possible transcriptions of the audio.
static MedicalResult.Builder	builder()
String	channelId() When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.
Double	endTime() The time, in seconds, from the beginning of the audio stream to the end of the result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlternatives() For responses, this returns true if the service returned a value for the Alternatives property.
int	hashCode()
Boolean	isPartial() Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio.
String	resultId() A unique identifier for the result.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalResult.Builder>	serializableBuilderClass()
Double	startTime() The time, in seconds, from the beginning of the audio stream to the beginning of the result.
MedicalResult.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

resultId

public final String resultId()

A unique identifier for the result.

Returns:

A unique identifier for the result.

startTime

public final Double startTime()

The time, in seconds, from the beginning of the audio stream to the beginning of the result.

Returns:

The time, in seconds, from the beginning of the audio stream to the beginning of the result.

endTime

public final Double endTime()

The time, in seconds, from the beginning of the audio stream to the end of the result.

Returns:

The time, in seconds, from the beginning of the audio stream to the end of the result.

isPartial

public final Boolean isPartial()

Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe Medical has additional transcription data to send. The IsPartial field is false to indicate that this is the last transcription result for the segment.

Returns:

Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe Medical has additional transcription data to send. The IsPartial field is false to indicate that this is the last transcription result for the segment.

hasAlternatives

public final boolean hasAlternatives()

For responses, this returns true if the service returned a value for the Alternatives property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

alternatives

public final List<MedicalAlternative> alternatives()

A list of possible transcriptions of the audio. Each alternative typically contains one Item that contains the result of the transcription.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlternatives() method.

Returns:

A list of possible transcriptions of the audio. Each alternative typically contains one Item that contains the result of the transcription.

channelId

public final String channelId()

When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Returns:

When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

toBuilder

public MedicalResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalResult.Builder,MedicalResult>

builder

public static MedicalResult.Builder builder()

serializableBuilderClass

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