MedicalScribeSettings
Makes it possible to control how your Medical Scribe job is processed using a
MedicalScribeSettings
object. Specify ChannelIdentification
if
ChannelDefinitions
are set. Enabled ShowSpeakerLabels
if ChannelIdentification
and ChannelDefinitions
are not set. One and only one of ChannelIdentification
and ShowSpeakerLabels
must be set. If ShowSpeakerLabels
is set, MaxSpeakerLabels
must also be set. Use Settings
to specify a vocabulary or vocabulary filter or both using VocabularyName
, VocabularyFilterName
.
VocabularyFilterMethod
must be specified if VocabularyFilterName
is set.
Contents
- ChannelIdentification
-
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.
For more information, see Transcribing multi-channel audio.
Type: Boolean
Required: No
- MaxSpeakerLabels
-
Specify the maximum number of speakers you want to partition in your media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the
MaxSpeakerLabels
field, you must set theShowSpeakerLabels
field to true.Type: Integer
Valid Range: Minimum value of 2. Maximum value of 30.
Required: No
- ShowSpeakerLabels
-
Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.
If you enable
ShowSpeakerLabels
in your request, you must also includeMaxSpeakerLabels
.For more information, see Partitioning speakers (diarization).
Type: Boolean
Required: No
- VocabularyFilterMethod
-
Specify how you want your custom vocabulary filter applied to your transcript.
To replace words with
***
, choosemask
.To delete words, choose
remove
.To flag words without changing them, choose
tag
.Type: String
Valid Values:
remove | mask | tag
Required: No
- VocabularyFilterName
-
The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.
Note that if you include
VocabularyFilterName
in your request, you must also includeVocabularyFilterMethod
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- VocabularyName
-
The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: