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

Class: Aws::TranscribeService::Types::TranscriptionJobSummary

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

Overview

Provides a summary of information about a transcription job.

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

The content redaction settings of 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, a description of the error.

Returns:

  • (String) —

    If the TranscriptionJobStatus field is FAILED, a description of the error.

#identified_language_score ⇒ Float

A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.

Returns:

  • (Float) —

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

#identify_language ⇒ Boolean

Whether automatic language identification was enabled for a transcription job.

Returns:

  • (Boolean) —

    Whether automatic language identification was enabled for a transcription job.

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

#model_settings ⇒ Types::ModelSettings

The object used to call your custom language model to your transcription job.

Returns:

  • (Types::ModelSettings) —

    The object used to call your custom language model to your transcription job.

    .

#output_location_type ⇒ String

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response\'s TranscriptFileUri field.

Possible values:

  • CUSTOMER_BUCKET
  • SERVICE_BUCKET

Returns:

  • (String) —

    Indicates the location of the output of the transcription job.

#start_time ⇒ Time

A timestamp that shows when the job started processing.

Returns:

  • (Time) —

    A timestamp that shows when the job started processing.

#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. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Possible values:

  • QUEUED
  • IN_PROGRESS
  • FAILED
  • COMPLETED

Returns:

  • (String) —

    The status of the transcription job.