Class: Aws::TranscribeService::Types::CallAnalyticsJob

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

Overview

Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#call_analytics_job_name ⇒ String

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

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#call_analytics_job_status ⇒ String

Provides the status of the specified Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#channel_definitions ⇒ Array<Types::ChannelDefinition>

Indicates which speaker is on which channel.

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#completion_time ⇒ Time

The date and time the specified Call Analytics 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) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the specified Call Analytics 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) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) you included in your request.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics 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 8,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.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#identified_language_score ⇒ Float

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

Returns:

  • (Float) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#media ⇒ Types::Media

Provides the Amazon S3 location of the media file you used in your Call Analytics request.

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#media_format ⇒ String

The format of the input media file.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  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) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::CallAnalyticsJobSettings

Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time the specified Call Analytics 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) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#transcript ⇒ Types::Transcript

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

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 247

class CallAnalyticsJob < Struct.new(
  :call_analytics_job_name,
  :call_analytics_job_status,
  :language_code,
  :media_sample_rate_hertz,
  :media_format,
  :media,
  :transcript,
  :start_time,
  :creation_time,
  :completion_time,
  :failure_reason,
  :data_access_role_arn,
  :identified_language_score,
  :settings,
  :channel_definitions)
  SENSITIVE = []
  include Aws::Structure
end