AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::TranscribeService::Types::MedicalTranscriptionJob

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#completion_timeTime

A timestamp that shows when the job was completed.

Returns:

  • (Time)

    A timestamp that shows when the job was completed.

#creation_timeTime

A timestamp that shows when the job was created.

Returns:

  • (Time)

    A timestamp that shows when the job was created.

#failure_reasonString

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 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 in the Amazon Web Services General Reference

Returns:

  • (String)

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

#language_codeString

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.

Possible values:

  • af-ZA
  • ar-AE
  • ar-SA
  • cy-GB
  • da-DK
  • de-CH
  • de-DE
  • en-AB
  • en-AU
  • en-GB
  • en-IE
  • en-IN
  • en-US
  • en-WL
  • es-ES
  • es-US
  • fa-IR
  • fr-CA
  • fr-FR
  • ga-IE
  • gd-GB
  • he-IL
  • hi-IN
  • id-ID
  • it-IT
  • ja-JP
  • ko-KR
  • ms-MY
  • nl-NL
  • pt-BR
  • pt-PT
  • ru-RU
  • ta-IN
  • te-IN
  • tr-TR
  • zh-CN

Returns:

  • (String)

    The language code for the language spoken in the source audio file.

#mediaTypes::Media

Describes the input media file in a transcription request.

Returns:

  • (Types::Media)

    Describes the input media file in a transcription request.

    .

#media_formatString

The format of the input media file.

Possible values:

  • mp3
  • mp4
  • wav
  • flac
  • ogg
  • amr
  • webm

Returns:

  • (String)

    The format of the input media file.

#media_sample_rate_hertzInteger

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.

Returns:

  • (Integer)

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

#medical_transcription_job_nameString

The name for a given medical transcription job.

Returns:

  • (String)

    The name for a given medical transcription job.

#settingsTypes::MedicalTranscriptionSetting

Object that contains object.

Returns:

#specialtyString

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

^

Possible values:

  • PRIMARYCARE

Returns:

  • (String)

    The medical specialty of any clinicians providing a dictation or having a conversation.

#start_timeTime

A timestamp that shows when the job started processing.

Returns:

  • (Time)

    A timestamp that shows when the job started processing.

#transcriptTypes::MedicalTranscript

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

Returns:

#transcription_job_statusString

The completion status of a medical transcription job.

Possible values:

  • QUEUED
  • IN_PROGRESS
  • FAILED
  • COMPLETED

Returns:

  • (String)

    The completion status of a medical transcription job.

#typeString

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

Possible values:

  • CONVERSATION
  • DICTATION

Returns:

  • (String)

    The type of speech in the transcription job.