software.amazon.awssdk.services.transcribestreaming.model

Interface MedicalResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MedicalResult.Builder,MedicalResult>, SdkBuilder<MedicalResult.Builder,MedicalResult>, SdkPojo

Enclosing class:

MedicalResult

public static interface MedicalResult.Builder
extends SdkPojo, CopyableBuilder<MedicalResult.Builder,MedicalResult>

Method Summary

Modifier and Type	Method and Description
MedicalResult.Builder	alternatives(Collection<MedicalAlternative> alternatives) A list of possible transcriptions of the audio.
MedicalResult.Builder	alternatives(Consumer<MedicalAlternative.Builder>... alternatives) A list of possible transcriptions of the audio.
MedicalResult.Builder	alternatives(MedicalAlternative... alternatives) A list of possible transcriptions of the audio.
MedicalResult.Builder	channelId(String channelId) When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.
MedicalResult.Builder	endTime(Double endTime) The time, in seconds, from the beginning of the audio stream to the end of the result.
MedicalResult.Builder	isPartial(Boolean isPartial) Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio.
MedicalResult.Builder	resultId(String resultId) A unique identifier for the result.
MedicalResult.Builder	startTime(Double startTime) The time, in seconds, from the beginning of the audio stream to the beginning of the result.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

resultId

MedicalResult.Builder resultId(String resultId)

A unique identifier for the result.

Parameters:

resultId - A unique identifier for the result.

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

MedicalResult.Builder startTime(Double startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

MedicalResult.Builder endTime(Double endTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isPartial

MedicalResult.Builder isPartial(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

alternatives

MedicalResult.Builder alternatives(Collection<MedicalAlternative> alternatives)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alternatives

MedicalResult.Builder alternatives(MedicalAlternative... alternatives)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alternatives

MedicalResult.Builder alternatives(Consumer<MedicalAlternative.Builder>... alternatives)

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

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #alternatives(List).

Parameters:

alternatives - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#alternatives(List)

channelId

MedicalResult.Builder channelId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.