software.amazon.awssdk.services.transcribestreaming.model

Interface StartMedicalStreamTranscriptionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>, SdkBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>, SdkPojo, SdkRequest.Builder, TranscribeStreamingRequest.Builder

Enclosing class:

StartMedicalStreamTranscriptionRequest

public static interface StartMedicalStreamTranscriptionRequest.Builder
extends TranscribeStreamingRequest.Builder, SdkPojo, CopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>

Method Summary

Modifier and Type	Method and Description
StartMedicalStreamTranscriptionRequest.Builder	contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.
StartMedicalStreamTranscriptionRequest.Builder	contentIdentificationType(String contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.
StartMedicalStreamTranscriptionRequest.Builder	enableChannelIdentification(Boolean enableChannelIdentification) Enables channel identification in multi-channel audio.
StartMedicalStreamTranscriptionRequest.Builder	languageCode(LanguageCode languageCode) Specify the language code that represents the language spoken in your audio.
StartMedicalStreamTranscriptionRequest.Builder	languageCode(String languageCode) Specify the language code that represents the language spoken in your audio.
StartMedicalStreamTranscriptionRequest.Builder	mediaEncoding(MediaEncoding mediaEncoding) Specify the encoding used for the input audio.
StartMedicalStreamTranscriptionRequest.Builder	mediaEncoding(String mediaEncoding) Specify the encoding used for the input audio.
StartMedicalStreamTranscriptionRequest.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate of the input audio (in hertz).
StartMedicalStreamTranscriptionRequest.Builder	numberOfChannels(Integer numberOfChannels) Specify the number of channels in your audio stream.
StartMedicalStreamTranscriptionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartMedicalStreamTranscriptionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartMedicalStreamTranscriptionRequest.Builder	sessionId(String sessionId) Specify a name for your transcription session.
StartMedicalStreamTranscriptionRequest.Builder	showSpeakerLabel(Boolean showSpeakerLabel) Enables speaker partitioning (diarization) in your transcription output.
StartMedicalStreamTranscriptionRequest.Builder	specialty(Specialty specialty) Specify the medical specialty contained in your audio.
StartMedicalStreamTranscriptionRequest.Builder	specialty(String specialty) Specify the medical specialty contained in your audio.
StartMedicalStreamTranscriptionRequest.Builder	type(String type) Specify the type of input audio.
StartMedicalStreamTranscriptionRequest.Builder	type(Type type) Specify the type of input audio.
StartMedicalStreamTranscriptionRequest.Builder	vocabularyName(String vocabularyName) Specify the name of the custom vocabulary that you want to use when processing your transcription.

Methods inherited from interface software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

languageCode

StartMedicalStreamTranscriptionRequest.Builder languageCode(String languageCode)

Specify the language code that represents the language spoken in your audio.

Amazon Transcribe Medical only supports US English (en-US).

Parameters:

languageCode - Specify the language code that represents the language spoken in your audio.

Amazon Transcribe Medical only supports US English (en-US).

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

StartMedicalStreamTranscriptionRequest.Builder languageCode(LanguageCode languageCode)

Specify the language code that represents the language spoken in your audio.

Amazon Transcribe Medical only supports US English (en-US).

Parameters:

languageCode - Specify the language code that represents the language spoken in your audio.

Amazon Transcribe Medical only supports US English (en-US).

Returns:

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

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

StartMedicalStreamTranscriptionRequest.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

Parameters:

mediaSampleRateHertz - The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

Returns:

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

mediaEncoding

StartMedicalStreamTranscriptionRequest.Builder mediaEncoding(String mediaEncoding)

Specify the encoding used for the input audio. Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

Parameters:

mediaEncoding - Specify the encoding used for the input audio. Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

Returns:

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

See Also:

MediaEncoding, MediaEncoding

mediaEncoding

StartMedicalStreamTranscriptionRequest.Builder mediaEncoding(MediaEncoding mediaEncoding)

Specify the encoding used for the input audio. Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

Parameters:

mediaEncoding - Specify the encoding used for the input audio. Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

Returns:

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

See Also:

MediaEncoding, MediaEncoding

vocabularyName

StartMedicalStreamTranscriptionRequest.Builder vocabularyName(String vocabularyName)

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

Parameters:

vocabularyName - Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

Returns:

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

specialty

StartMedicalStreamTranscriptionRequest.Builder specialty(String specialty)

Specify the medical specialty contained in your audio.

Parameters:

specialty - Specify the medical specialty contained in your audio.

Returns:

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

See Also:

Specialty, Specialty

specialty

StartMedicalStreamTranscriptionRequest.Builder specialty(Specialty specialty)

Specify the medical specialty contained in your audio.

Parameters:

specialty - Specify the medical specialty contained in your audio.

Returns:

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

See Also:

Specialty, Specialty

type

StartMedicalStreamTranscriptionRequest.Builder type(String type)

Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

Parameters:

type - Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

Returns:

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

See Also:

Type, Type

type

StartMedicalStreamTranscriptionRequest.Builder type(Type type)

Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

Parameters:

type - Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

Returns:

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

See Also:

Type, Type

showSpeakerLabel

StartMedicalStreamTranscriptionRequest.Builder showSpeakerLabel(Boolean showSpeakerLabel)

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization).

Parameters:

showSpeakerLabel - Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization).

Returns:

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

sessionId

StartMedicalStreamTranscriptionRequest.Builder sessionId(String sessionId)

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

Parameters:

sessionId - Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

Returns:

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

enableChannelIdentification

StartMedicalStreamTranscriptionRequest.Builder enableChannelIdentification(Boolean enableChannelIdentification)

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

For more information, see Transcribing multi-channel audio.

Parameters:

enableChannelIdentification - Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

For more information, see Transcribing multi-channel audio.

Returns:

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

numberOfChannels

StartMedicalStreamTranscriptionRequest.Builder numberOfChannels(Integer numberOfChannels)

Specify the number of channels in your audio stream. Up to two channels are supported.

Parameters:

numberOfChannels - Specify the number of channels in your audio stream. Up to two channels are supported.

Returns:

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

contentIdentificationType

StartMedicalStreamTranscriptionRequest.Builder contentIdentificationType(String contentIdentificationType)

Labels all personal health information (PHI) identified in your transcript.

Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

For more information, see Identifying personal health information (PHI) in a transcription.

Parameters:

contentIdentificationType - Labels all personal health information (PHI) identified in your transcript.

Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

For more information, see Identifying personal health information (PHI) in a transcription.

Returns:

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

See Also:

MedicalContentIdentificationType, MedicalContentIdentificationType

contentIdentificationType

StartMedicalStreamTranscriptionRequest.Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType)

Labels all personal health information (PHI) identified in your transcript.

Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

For more information, see Identifying personal health information (PHI) in a transcription.

Parameters:

contentIdentificationType - Labels all personal health information (PHI) identified in your transcript.

Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

For more information, see Identifying personal health information (PHI) in a transcription.

Returns:

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

See Also:

MedicalContentIdentificationType, MedicalContentIdentificationType

overrideConfiguration

StartMedicalStreamTranscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartMedicalStreamTranscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder