class Aws::TranscribeService::Types::CallAnalyticsJob

Describes an asynchronous analytics job that was created with the `StartAnalyticsJob` operation.

@!attribute [rw] call_analytics_job_name

The name of the call analytics job.
@return [String]

@!attribute [rw] call_analytics_job_status

The status of the analytics job.
@return [String]

@!attribute [rw] language_code

If you know the language spoken between the customer and the agent,
specify a language code for this field.

If you don't know the language, you can leave this field blank, and
Amazon Transcribe will use machine learning to automatically
identify the language. To improve the accuracy of language
identification, you can provide an array containing the possible
language codes for the language spoken in your audio. Refer to
[Supported languages and language-specific features][1] for
additional information.

[1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html
@return [String]

@!attribute [rw] media_sample_rate_hertz

The sample rate, in Hertz, of the audio.
@return [Integer]

@!attribute [rw] media_format

The format of the input audio file. Note: for call analytics jobs,
only the following media formats are supported: MP3, MP4, WAV, FLAC,
OGG, and WebM.
@return [String]

@!attribute [rw] media

Describes the input media file in a transcription request.
@return [Types::Media]

@!attribute [rw] transcript

Identifies the location of a transcription.
@return [Types::Transcript]

@!attribute [rw] start_time

A timestamp that shows when the analytics job started processing.
@return [Time]

@!attribute [rw] creation_time

A timestamp that shows when the analytics job was created.
@return [Time]

@!attribute [rw] completion_time

A timestamp that shows when the analytics job was completed.
@return [Time]

@!attribute [rw] failure_reason

If the `AnalyticsJobStatus` 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 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 8,000 and 48,000 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].

[1]: https://docs.aws.amazon.com/general/latest/gr/Welcome.html
@return [String]

@!attribute [rw] data_access_role_arn

The Amazon Resource Number (ARN) that you use to get access to the
analytics job.
@return [String]

@!attribute [rw] identified_language_score

A value between zero and one that Amazon Transcribe assigned to the
language that it identified in the source audio. This value appears
only when you don't provide a single language code. Larger values
indicate that Amazon Transcribe has higher confidence in the
language that it identified
@return [Float]

@!attribute [rw] settings

Provides information about the settings used to run a transcription
job.
@return [Types::CallAnalyticsJobSettings]

@!attribute [rw] channel_definitions

Shows numeric values to indicate the channel assigned to the
agent's audio and the channel assigned to the customer's audio.
@return [Array<Types::ChannelDefinition>]

@see docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJob AWS API Documentation

Constants

SENSITIVE