« blib/lib/Paws/Transcribe/MedicalTranscriptionJobSummary.pm
↑ Summary
blib/lib/Paws/Transcribe/ModelSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Transcribe::MedicalTranscriptionSetting; | ||
| 3 | use Moose; | ||
| 4 | has ChannelIdentification => (is => 'ro', isa => 'Bool'); | ||
| 5 | has MaxAlternatives => (is => 'ro', isa => 'Int'); | ||
| 6 | has MaxSpeakerLabels => (is => 'ro', isa => 'Int'); | ||
| 7 | has ShowAlternatives => (is => 'ro', isa => 'Bool'); | ||
| 8 | has ShowSpeakerLabels => (is => 'ro', isa => 'Bool'); | ||
| 9 | has VocabularyName => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Transcribe::MedicalTranscriptionSetting | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Transcribe::MedicalTranscriptionSetting object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ChannelIdentification => $value, ..., VocabularyName => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::MedicalTranscriptionSetting object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ChannelIdentification | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Optional settings for the StartMedicalTranscriptionJob operation. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ChannelIdentification => Bool | ||
| 47 | |||
| 48 | Instructs Amazon Transcribe Medical to process each audio channel | ||
| 49 | separately and then merge the transcription output of each channel into | ||
| 50 | a single transcription. | ||
| 51 | |||
| 52 | Amazon Transcribe Medical also produces a transcription of each item | ||
| 53 | detected on an audio channel, including the start time and end time of | ||
| 54 | the item and alternative transcriptions of item. The alternative | ||
| 55 | transcriptions also come with confidence scores provided by Amazon | ||
| 56 | Transcribe Medical. | ||
| 57 | |||
| 58 | You can't set both C<ShowSpeakerLabels> and C<ChannelIdentification> in | ||
| 59 | the same request. If you set both, your request returns a | ||
| 60 | C<BadRequestException> | ||
| 61 | |||
| 62 | |||
| 63 | =head2 MaxAlternatives => Int | ||
| 64 | |||
| 65 | The maximum number of alternatives that you tell the service to return. | ||
| 66 | If you specify the C<MaxAlternatives> field, you must set the | ||
| 67 | C<ShowAlternatives> field to true. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 MaxSpeakerLabels => Int | ||
| 71 | |||
| 72 | The maximum number of speakers to identify in the input audio. If there | ||
| 73 | are more speakers in the audio than this number, multiple speakers are | ||
| 74 | identified as a single speaker. If you specify the C<MaxSpeakerLabels> | ||
| 75 | field, you must set the C<ShowSpeakerLabels> field to true. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ShowAlternatives => Bool | ||
| 79 | |||
| 80 | Determines whether alternative transcripts are generated along with the | ||
| 81 | transcript that has the highest confidence. If you set | ||
| 82 | C<ShowAlternatives> field to true, you must also set the maximum number | ||
| 83 | of alternatives to return in the C<MaxAlternatives> field. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 ShowSpeakerLabels => Bool | ||
| 87 | |||
| 88 | Determines whether the transcription job uses speaker recognition to | ||
| 89 | identify different speakers in the input audio. Speaker recognition | ||
| 90 | labels individual speakers in the audio file. If you set the | ||
| 91 | C<ShowSpeakerLabels> field to true, you must also set the maximum | ||
| 92 | number of speaker labels in the C<MaxSpeakerLabels> field. | ||
| 93 | |||
| 94 | You can't set both C<ShowSpeakerLabels> and C<ChannelIdentification> in | ||
| 95 | the same request. If you set both, your request returns a | ||
| 96 | C<BadRequestException>. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 VocabularyName => Str | ||
| 100 | |||
| 101 | The name of the vocabulary to use when processing a medical | ||
| 102 | transcription job. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::Transcribe> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |