/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Transcribe::MedicalTranscriptionJob

NAME

Paws::Transcribe::MedicalTranscriptionJob

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Transcribe::MedicalTranscriptionJob object:

$service_obj->Method(Att1 => { CompletionTime => $value, ..., Type => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::MedicalTranscriptionJob object:

$result = $service_obj->Method(...);
$result->Att1->CompletionTime

DESCRIPTION

The data structure that contains the information for a medical transcription job.

ATTRIBUTES

CompletionTime => Str

A timestamp that shows when the job was completed.

ContentIdentificationType => Str

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

CreationTime => Str

A timestamp that shows when the job was created.

FailureReason => Str

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field contains one of the following values:

  • Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

  • The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.

  • Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.

  • The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

  • Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) in the Amazon Transcribe Medical Guide

  • Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html) in the Amazon Web Services General Reference

LanguageCode => Str

The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

Media => Paws::Transcribe::Media

MediaFormat => Str

The format of the input media file.

MediaSampleRateHertz => Int

The sample rate, in Hertz, of the source audio containing medical information.

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

MedicalTranscriptionJobName => Str

The name for a given medical transcription job.

Settings => Paws::Transcribe::MedicalTranscriptionSetting

Object that contains object.

Specialty => Str

The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields:

  • Family Medicine

StartTime => Str

A timestamp that shows when the job started processing.

Transcript => Paws::Transcribe::MedicalTranscript

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

TranscriptionJobStatus => Str

The completion status of a medical transcription job.

Type => Str

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Transcribe

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues