Struct aws_sdk_transcribe::types::MedicalScribeSettings

#[non_exhaustive]
pub struct MedicalScribeSettings {
    pub show_speaker_labels: Option<bool>,
    pub max_speaker_labels: Option<i32>,
    pub channel_identification: Option<bool>,
    pub vocabulary_name: Option<String>,
    pub vocabulary_filter_name: Option<String>,
    pub vocabulary_filter_method: Option<VocabularyFilterMethod>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

show_speaker_labels: Option<bool>

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 include MaxSpeakerLabels.

For more information, see Partitioning speakers (diarization).

max_speaker_labels: Option<i32>

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 the ShowSpeakerLabels field to true.

channel_identification: Option<bool>

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.

vocabulary_name: Option<String>

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

vocabulary_filter_name: Option<String>

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 include VocabularyFilterMethod.

vocabulary_filter_method: Option<VocabularyFilterMethod>

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

Implementations

impl MedicalScribeSettings

pub fn show_speaker_labels(&self) -> Option<bool>

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 include MaxSpeakerLabels.

For more information, see Partitioning speakers (diarization).

pub fn max_speaker_labels(&self) -> Option<i32>

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 the ShowSpeakerLabels field to true.

pub fn channel_identification(&self) -> Option<bool>

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.

pub fn vocabulary_name(&self) -> Option<&str>

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

pub fn vocabulary_filter_name(&self) -> Option<&str>

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 include VocabularyFilterMethod.

pub fn vocabulary_filter_method(&self) -> Option<&VocabularyFilterMethod>

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

impl MedicalScribeSettings

pub fn builder() -> MedicalScribeSettingsBuilder

Creates a new builder-style object to manufacture MedicalScribeSettings.

Trait Implementations

impl Clone for MedicalScribeSettings

fn clone(&self) -> MedicalScribeSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MedicalScribeSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MedicalScribeSettings

fn eq(&self, other: &MedicalScribeSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MedicalScribeSettings