Class: Aws::TranscribeService::Types::TranscriptionJob

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

Overview

Describes an asynchronous transcription job that was created with the `StartTranscriptionJob` operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#completion_timeTime

A timestamp that shows when the job was completed.

Returns:

  • (Time)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#content_redactionTypes::ContentRedaction

An object that describes content redaction settings for the transcription job.


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the job was created.

Returns:

  • (Time)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  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 can contain 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 that 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 Amazon Transcribe can process. For more information, see [Limits] in the *Amazon Transcribe Developer Guide*.

  • `Invalid number of channels: number of channels too large` - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see [Amazon Transcribe Limits] 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/aws_service_limits.html#limits-amazon-transcribe

Returns:

  • (String)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#identified_language_scoreFloat

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

Returns:

  • (Float)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#identify_languageBoolean

A value that shows if automatic language identification was enabled for a transcription job.

Returns:

  • (Boolean)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#job_execution_settingsTypes::JobExecutionSettings

Provides information about how a transcription job is executed.


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language code for the input speech.

Returns:

  • (String)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#language_optionsArray<String>

An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

Returns:

  • (Array<String>)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#mediaTypes::Media

An object that describes the input media for the transcription job.

Returns:


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#media_formatString

The format of the input media file.

Returns:

  • (String)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertzInteger

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

Returns:

  • (Integer)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#model_settingsTypes::ModelSettings

An object containing the details of your custom language model.


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#settingsTypes::Settings

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

Returns:


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

A timestamp that shows with the job was started processing.

Returns:

  • (Time)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#transcriptTypes::Transcript

An object that describes the output of the transcription job.

Returns:


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_nameString

The name of the transcription job.

Returns:

  • (String)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end

#transcription_job_statusString

The status of the transcription job.

Returns:

  • (String)

2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
# File 'lib/aws-sdk-transcribeservice/types.rb', line 2440

class TranscriptionJob < Struct.new(
  :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,
  :model_settings,
  :job_execution_settings,
  :content_redaction,
  :identify_language,
  :language_options,
  :identified_language_score)
  SENSITIVE = []
  include Aws::Structure
end