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

Inherits:

Struct

Object
Struct
Aws::TranscribeService::Types::MedicalTranscriptionJob

show all

Includes:: Structure

Defined in:: lib/aws-sdk-transcribeservice/types.rb

Overview

Provides detailed information about a medical transcription job.

To view the status of the specified medical transcription job, check the ‘TranscriptionJobStatus` field. If the status is `COMPLETED`, the job is finished and you can find the results at the location specified in `TranscriptFileUri`. If the status is `FAILED`, `FailureReason` provides details on why your transcription job failed.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#completion_time ⇒ Time

The date and time the specified medical transcription job finished processing.
#content_identification_type ⇒ String

Indicates whether content identification was enabled for your transcription request.
#creation_time ⇒ Time

The date and time the specified medical transcription job request was made.
#failure_reason ⇒ String

If ‘TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job request failed.
#language_code ⇒ String

The language code used to create your medical transcription job.
#media ⇒ Types::Media

Describes the Amazon S3 location of the media file you want to use in your request.
#media_format ⇒ String

The format of the input media file.
#media_sample_rate_hertz ⇒ Integer

The sample rate, in hertz, of the audio track in your input media file.
#medical_transcription_job_name ⇒ String

The name of the medical transcription job.
#settings ⇒ Types::MedicalTranscriptionSetting

Provides information on any additional settings that were included in your request.
#specialty ⇒ String

Describes the medical specialty represented in your media.
#start_time ⇒ Time

The date and time the specified medical transcription job began processing.
#tags ⇒ Array<Types::Tag>

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
#transcript ⇒ Types::MedicalTranscript

Provides you with the Amazon S3 URI you can use to access your transcript.
#transcription_job_status ⇒ String

Provides the status of the specified medical transcription job.
#type ⇒ String

Indicates whether the input media is a dictation or a conversation, as specified in the ‘StartMedicalTranscriptionJob` request.

Instance Attribute Details

#completion_time ⇒ `Time`

The date and time the specified medical transcription job finished processing.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:33:13.922000-07:00` represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#content_identification_type ⇒ `String`

Indicates whether content identification was enabled for your transcription request.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

The date and time the specified medical transcription job request was made.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.761000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

If ‘TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job request failed.

The ‘FailureReason` field contains one of the following values:

‘Unsupported media format`.

The media format specified in ‘MediaFormat` isn’t valid. Refer to refer to the ‘MediaFormat` parameter for a list of supported formats.
‘The media format provided does not match the detected media format`.

The media format specified in ‘MediaFormat` doesn’t match the format of the input file. Check the media format of your media file and correct the specified value.
‘Invalid sample rate for audio file`.

The sample rate specified in ‘MediaSampleRateHertz` isn’t valid. The sample rate must be between 16,000 and 48,000 hertz.
‘The sample rate provided does not match the detected sample rate`.

The sample rate specified in ‘MediaSampleRateHertz` doesn’t match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
‘Invalid file size: file size too large`.

The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to [Service quotas].
‘Invalid number of channels: number of channels too large`.

Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to [Service quotas].

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

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ `String`

The language code used to create your medical transcription job. US English (‘en-US`) is the only supported language for medical transcriptions.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media ⇒ `Types::Media`

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the ‘MediaFormat` parameter or the [Media formats] section in the Amazon S3 Developer Guide.

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio

Returns:

(Types::Media)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media_format ⇒ `String`

The format of the input media file.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertz ⇒ `Integer`

The sample rate, in hertz, of the audio track in your input media file.

Returns:

(Integer)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#medical_transcription_job_name ⇒ `String`

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ `Types::MedicalTranscriptionSetting`

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Returns:

(Types::MedicalTranscriptionSetting)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#specialty ⇒ `String`

Describes the medical specialty represented in your media.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The date and time the specified medical transcription job began processing.

Timestamps are in the format ‘YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC`. For example, ‘2022-05-04T12:32:58.789000-07:00` represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Returns:

(Time)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transcript ⇒ `Types::MedicalTranscript`

Provides you with the Amazon S3 URI you can use to access your transcript.

Returns:

(Types::MedicalTranscript)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_status ⇒ `String`

Provides the status of the specified medical transcription job.

If the status is ‘COMPLETED`, the job is finished and you can find the results at the location specified in `TranscriptFileUri`. If the status is `FAILED`, `FailureReason` provides details on why your transcription job failed.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

Indicates whether the input media is a dictation or a conversation, as specified in the ‘StartMedicalTranscriptionJob` request.

Returns:

(String)

# File 'lib/aws-sdk-transcribeservice/types.rb', line 3276

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#completion_time ⇒ Time

#content_identification_type ⇒ String

#creation_time ⇒ Time

#failure_reason ⇒ String

#language_code ⇒ String

#media ⇒ Types::Media

#media_format ⇒ String

#media_sample_rate_hertz ⇒ Integer

#medical_transcription_job_name ⇒ String

#settings ⇒ Types::MedicalTranscriptionSetting

#specialty ⇒ String

#start_time ⇒ Time

#tags ⇒ Array<Types::Tag>

#transcript ⇒ Types::MedicalTranscript

#transcription_job_status ⇒ String

#type ⇒ String

#completion_time ⇒ `Time`

#content_identification_type ⇒ `String`

#creation_time ⇒ `Time`

#failure_reason ⇒ `String`

#language_code ⇒ `String`

#media ⇒ `Types::Media`

#media_format ⇒ `String`

#media_sample_rate_hertz ⇒ `Integer`

#medical_transcription_job_name ⇒ `String`

#settings ⇒ `Types::MedicalTranscriptionSetting`

#specialty ⇒ `String`

#start_time ⇒ `Time`

#tags ⇒ `Array<Types::Tag>`

#transcript ⇒ `Types::MedicalTranscript`

#transcription_job_status ⇒ `String`

#type ⇒ `String`