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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribeservice/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#completion_timeTime

A timestamp that shows when the job was completed.

Returns:

  • (Time)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#content_identification_typeString

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.

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the job was created.

Returns:

  • (Time)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#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*

[1]: docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits [2]: docs.aws.amazon.com/general/latest/gr/transcribe-medical.html

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#mediaTypes::Media

Describes the input media file in a transcription request.

Returns:


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#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)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#medical_transcription_job_nameString

The name for a given medical transcription job.

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#settingsTypes::MedicalTranscriptionSetting

Object that contains object.


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#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

^

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

A timestamp that shows when the job started processing.

Returns:

  • (Time)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#transcriptTypes::MedicalTranscript

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


1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_statusString

The completion status of a medical transcription job.

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (String)

1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'lib/aws-sdk-transcribeservice/types.rb', line 1584

class MedicalTranscriptionJob < Struct.new(
  :medical_transcription_job_name,
  :transcription_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :settings,
  :content_identification_type,
  :specialty,
  :type)
  SENSITIVE = []
  include Aws::Structure
end