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

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

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

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#completion_time ⇒ Time

A timestamp that shows when the job was completed.

Returns:

  • (Time) —

    A timestamp that shows when the job was completed.

#content_redaction ⇒ Types::ContentRedaction

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

Returns:

#creation_time ⇒ Time

A timestamp that shows when the job was created.

Returns:

  • (Time) —

    A timestamp that shows when the job was created.

#failure_reason ⇒ String

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.

Returns:

  • (String) —

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

#identified_language_score ⇒ Float

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

    A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio.

#identify_language ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#job_execution_settings ⇒ Types::JobExecutionSettings

Provides information about how a transcription job is executed.

Returns:

#language_code ⇒ String

The language code for the input speech.

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 input speech.

#language_options ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#media ⇒ Types::Media

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

Returns:

  • (Types::Media) —

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

#media_format ⇒ String

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_hertz ⇒ Integer

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

Returns:

  • (Integer) —

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

#model_settings ⇒ Types::ModelSettings

An object containing the details of your custom language model.

Returns:

#settings ⇒ Types::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:

#start_time ⇒ Time

A timestamp that shows with the job was started processing.

Returns:

  • (Time) —

    A timestamp that shows with the job was started processing.

#transcript ⇒ Types::Transcript

An object that describes the output of the transcription job.

Returns:

  • (Types::Transcript) —

    An object that describes the output of the transcription job.

#transcription_job_name ⇒ String

The name of the transcription job.

Returns:

  • (String) —

    The name of the transcription job.

#transcription_job_status ⇒ String

The status of the transcription job.

Possible values:

  • QUEUED
  • IN_PROGRESS
  • FAILED
  • COMPLETED

Returns:

  • (String) —

    The status of the transcription job.