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) Set this field to PHI to identify personal health information in the transcription output.
StartMedicalStreamTranscriptionRequest.Builder	contentIdentificationType(String contentIdentificationType) Set this field to PHI to identify personal health information in the transcription output.
StartMedicalStreamTranscriptionRequest.Builder	enableChannelIdentification(Boolean enableChannelIdentification) When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
StartMedicalStreamTranscriptionRequest.Builder	languageCode(LanguageCode languageCode) Indicates the source language used in the input audio stream.
StartMedicalStreamTranscriptionRequest.Builder	languageCode(String languageCode) Indicates the source language used in the input audio stream.
StartMedicalStreamTranscriptionRequest.Builder	mediaEncoding(MediaEncoding mediaEncoding) The encoding used for the input audio.
StartMedicalStreamTranscriptionRequest.Builder	mediaEncoding(String mediaEncoding) 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) The number of channels that are in your audio stream.
StartMedicalStreamTranscriptionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartMedicalStreamTranscriptionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartMedicalStreamTranscriptionRequest.Builder	sessionId(String sessionId) Optional.
StartMedicalStreamTranscriptionRequest.Builder	showSpeakerLabel(Boolean showSpeakerLabel) When true, enables speaker identification in your real-time stream.
StartMedicalStreamTranscriptionRequest.Builder	specialty(Specialty specialty) The medical specialty of the clinician or provider.
StartMedicalStreamTranscriptionRequest.Builder	specialty(String specialty) The medical specialty of the clinician or provider.
StartMedicalStreamTranscriptionRequest.Builder	type(String type) The type of input audio.
StartMedicalStreamTranscriptionRequest.Builder	type(Type type) The type of input audio.
StartMedicalStreamTranscriptionRequest.Builder	vocabularyName(String vocabularyName) The name of the medical custom vocabulary to use when processing the real-time stream.

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)

Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).

Parameters:

languageCode - Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is 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)

Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).

Parameters:

languageCode - Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is 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)

The encoding used for the input audio.

Parameters:

mediaEncoding - The encoding used for the input audio.

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)

The encoding used for the input audio.

Parameters:

mediaEncoding - The encoding used for the input audio.

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)

The name of the medical custom vocabulary to use when processing the real-time stream.

Parameters:

vocabularyName - The name of the medical custom vocabulary to use when processing the real-time stream.

Returns:

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

specialty

StartMedicalStreamTranscriptionRequest.Builder specialty(String specialty)

The medical specialty of the clinician or provider.

Parameters:

specialty - The medical specialty of the clinician or provider.

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)

The medical specialty of the clinician or provider.

Parameters:

specialty - The medical specialty of the clinician or provider.

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)

The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.

Parameters:

type - The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.

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)

The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.

Parameters:

type - The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.

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)

When true, enables speaker identification in your real-time stream.

Parameters:

showSpeakerLabel - When true, enables speaker identification in your real-time stream.

Returns:

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

sessionId

StartMedicalStreamTranscriptionRequest.Builder sessionId(String sessionId)

Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.

Parameters:

sessionId - Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.

Returns:

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

enableChannelIdentification

StartMedicalStreamTranscriptionRequest.Builder enableChannelIdentification(Boolean enableChannelIdentification)

When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Parameters:

enableChannelIdentification - When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Returns:

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

numberOfChannels

StartMedicalStreamTranscriptionRequest.Builder numberOfChannels(Integer numberOfChannels)

The number of channels that are in your audio stream.

Parameters:

numberOfChannels - The number of channels that are in your audio stream.

Returns:

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

contentIdentificationType

StartMedicalStreamTranscriptionRequest.Builder contentIdentificationType(String contentIdentificationType)

Set this field to PHI to identify personal health information in the transcription output.

Parameters:

contentIdentificationType - Set this field to PHI to identify personal health information in the transcription output.

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)

Set this field to PHI to identify personal health information in the transcription output.

Parameters:

contentIdentificationType - Set this field to PHI to identify personal health information in the transcription output.

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