AWS SDK for C++  1.9.159
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::CallAnalyticsJob Class Reference

#include <CallAnalyticsJob.h>

Public Member Functions

 CallAnalyticsJob ()
 
 CallAnalyticsJob (Aws::Utils::Json::JsonView jsonValue)
 
CallAnalyticsJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCallAnalyticsJobName () const
 
bool CallAnalyticsJobNameHasBeenSet () const
 
void SetCallAnalyticsJobName (const Aws::String &value)
 
void SetCallAnalyticsJobName (Aws::String &&value)
 
void SetCallAnalyticsJobName (const char *value)
 
CallAnalyticsJobWithCallAnalyticsJobName (const Aws::String &value)
 
CallAnalyticsJobWithCallAnalyticsJobName (Aws::String &&value)
 
CallAnalyticsJobWithCallAnalyticsJobName (const char *value)
 
const CallAnalyticsJobStatusGetCallAnalyticsJobStatus () const
 
bool CallAnalyticsJobStatusHasBeenSet () const
 
void SetCallAnalyticsJobStatus (const CallAnalyticsJobStatus &value)
 
void SetCallAnalyticsJobStatus (CallAnalyticsJobStatus &&value)
 
CallAnalyticsJobWithCallAnalyticsJobStatus (const CallAnalyticsJobStatus &value)
 
CallAnalyticsJobWithCallAnalyticsJobStatus (CallAnalyticsJobStatus &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
CallAnalyticsJobWithLanguageCode (const LanguageCode &value)
 
CallAnalyticsJobWithLanguageCode (LanguageCode &&value)
 
int GetMediaSampleRateHertz () const
 
bool MediaSampleRateHertzHasBeenSet () const
 
void SetMediaSampleRateHertz (int value)
 
CallAnalyticsJobWithMediaSampleRateHertz (int value)
 
const MediaFormatGetMediaFormat () const
 
bool MediaFormatHasBeenSet () const
 
void SetMediaFormat (const MediaFormat &value)
 
void SetMediaFormat (MediaFormat &&value)
 
CallAnalyticsJobWithMediaFormat (const MediaFormat &value)
 
CallAnalyticsJobWithMediaFormat (MediaFormat &&value)
 
const MediaGetMedia () const
 
bool MediaHasBeenSet () const
 
void SetMedia (const Media &value)
 
void SetMedia (Media &&value)
 
CallAnalyticsJobWithMedia (const Media &value)
 
CallAnalyticsJobWithMedia (Media &&value)
 
const TranscriptGetTranscript () const
 
bool TranscriptHasBeenSet () const
 
void SetTranscript (const Transcript &value)
 
void SetTranscript (Transcript &&value)
 
CallAnalyticsJobWithTranscript (const Transcript &value)
 
CallAnalyticsJobWithTranscript (Transcript &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
CallAnalyticsJobWithStartTime (const Aws::Utils::DateTime &value)
 
CallAnalyticsJobWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
CallAnalyticsJobWithCreationTime (const Aws::Utils::DateTime &value)
 
CallAnalyticsJobWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletionTime () const
 
bool CompletionTimeHasBeenSet () const
 
void SetCompletionTime (const Aws::Utils::DateTime &value)
 
void SetCompletionTime (Aws::Utils::DateTime &&value)
 
CallAnalyticsJobWithCompletionTime (const Aws::Utils::DateTime &value)
 
CallAnalyticsJobWithCompletionTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
CallAnalyticsJobWithFailureReason (const Aws::String &value)
 
CallAnalyticsJobWithFailureReason (Aws::String &&value)
 
CallAnalyticsJobWithFailureReason (const char *value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
CallAnalyticsJobWithDataAccessRoleArn (const Aws::String &value)
 
CallAnalyticsJobWithDataAccessRoleArn (Aws::String &&value)
 
CallAnalyticsJobWithDataAccessRoleArn (const char *value)
 
double GetIdentifiedLanguageScore () const
 
bool IdentifiedLanguageScoreHasBeenSet () const
 
void SetIdentifiedLanguageScore (double value)
 
CallAnalyticsJobWithIdentifiedLanguageScore (double value)
 
const CallAnalyticsJobSettingsGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const CallAnalyticsJobSettings &value)
 
void SetSettings (CallAnalyticsJobSettings &&value)
 
CallAnalyticsJobWithSettings (const CallAnalyticsJobSettings &value)
 
CallAnalyticsJobWithSettings (CallAnalyticsJobSettings &&value)
 
const Aws::Vector< ChannelDefinition > & GetChannelDefinitions () const
 
bool ChannelDefinitionsHasBeenSet () const
 
void SetChannelDefinitions (const Aws::Vector< ChannelDefinition > &value)
 
void SetChannelDefinitions (Aws::Vector< ChannelDefinition > &&value)
 
CallAnalyticsJobWithChannelDefinitions (const Aws::Vector< ChannelDefinition > &value)
 
CallAnalyticsJobWithChannelDefinitions (Aws::Vector< ChannelDefinition > &&value)
 
CallAnalyticsJobAddChannelDefinitions (const ChannelDefinition &value)
 
CallAnalyticsJobAddChannelDefinitions (ChannelDefinition &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 41 of file CallAnalyticsJob.h.

Constructor & Destructor Documentation

◆ CallAnalyticsJob() [1/2]

Aws::TranscribeService::Model::CallAnalyticsJob::CallAnalyticsJob ( )

◆ CallAnalyticsJob() [2/2]

Aws::TranscribeService::Model::CallAnalyticsJob::CallAnalyticsJob ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddChannelDefinitions() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::AddChannelDefinitions ( ChannelDefinition &&  value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 792 of file CallAnalyticsJob.h.

◆ AddChannelDefinitions() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::AddChannelDefinitions ( const ChannelDefinition value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 786 of file CallAnalyticsJob.h.

◆ CallAnalyticsJobNameHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::CallAnalyticsJobNameHasBeenSet ( ) const
inline

The name of the call analytics job.

Definition at line 58 of file CallAnalyticsJob.h.

◆ CallAnalyticsJobStatusHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::CallAnalyticsJobStatusHasBeenSet ( ) const
inline

The status of the analytics job.

Definition at line 99 of file CallAnalyticsJob.h.

◆ ChannelDefinitionsHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::ChannelDefinitionsHasBeenSet ( ) const
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 756 of file CallAnalyticsJob.h.

◆ CompletionTimeHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::CompletionTimeHasBeenSet ( ) const
inline

A timestamp that shows when the analytics job was completed.

Definition at line 361 of file CallAnalyticsJob.h.

◆ CreationTimeHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::CreationTimeHasBeenSet ( ) const
inline

A timestamp that shows when the analytics job was created.

Definition at line 330 of file CallAnalyticsJob.h.

◆ DataAccessRoleArnHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::DataAccessRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 637 of file CallAnalyticsJob.h.

◆ FailureReasonHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::FailureReasonHasBeenSet ( ) const
inline

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.

Definition at line 442 of file CallAnalyticsJob.h.

◆ GetCallAnalyticsJobName()

const Aws::String& Aws::TranscribeService::Model::CallAnalyticsJob::GetCallAnalyticsJobName ( ) const
inline

The name of the call analytics job.

Definition at line 53 of file CallAnalyticsJob.h.

◆ GetCallAnalyticsJobStatus()

const CallAnalyticsJobStatus& Aws::TranscribeService::Model::CallAnalyticsJob::GetCallAnalyticsJobStatus ( ) const
inline

The status of the analytics job.

Definition at line 94 of file CallAnalyticsJob.h.

◆ GetChannelDefinitions()

const Aws::Vector<ChannelDefinition>& Aws::TranscribeService::Model::CallAnalyticsJob::GetChannelDefinitions ( ) const
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 750 of file CallAnalyticsJob.h.

◆ GetCompletionTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::CallAnalyticsJob::GetCompletionTime ( ) const
inline

A timestamp that shows when the analytics job was completed.

Definition at line 356 of file CallAnalyticsJob.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::CallAnalyticsJob::GetCreationTime ( ) const
inline

A timestamp that shows when the analytics job was created.

Definition at line 325 of file CallAnalyticsJob.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::TranscribeService::Model::CallAnalyticsJob::GetDataAccessRoleArn ( ) const
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 630 of file CallAnalyticsJob.h.

◆ GetFailureReason()

const Aws::String& Aws::TranscribeService::Model::CallAnalyticsJob::GetFailureReason ( ) const
inline

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.

Definition at line 412 of file CallAnalyticsJob.h.

◆ GetIdentifiedLanguageScore()

double Aws::TranscribeService::Model::CallAnalyticsJob::GetIdentifiedLanguageScore ( ) const
inline

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

Definition at line 688 of file CallAnalyticsJob.h.

◆ GetLanguageCode()

const LanguageCode& Aws::TranscribeService::Model::CallAnalyticsJob::GetLanguageCode ( ) const
inline

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 for additional information.

Definition at line 132 of file CallAnalyticsJob.h.

◆ GetMedia()

const Media& Aws::TranscribeService::Model::CallAnalyticsJob::GetMedia ( ) const
inline

Definition at line 254 of file CallAnalyticsJob.h.

◆ GetMediaFormat()

const MediaFormat& Aws::TranscribeService::Model::CallAnalyticsJob::GetMediaFormat ( ) const
inline

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.

Definition at line 220 of file CallAnalyticsJob.h.

◆ GetMediaSampleRateHertz()

int Aws::TranscribeService::Model::CallAnalyticsJob::GetMediaSampleRateHertz ( ) const
inline

The sample rate, in Hertz, of the audio.

Definition at line 198 of file CallAnalyticsJob.h.

◆ GetSettings()

const CallAnalyticsJobSettings& Aws::TranscribeService::Model::CallAnalyticsJob::GetSettings ( ) const
inline

Provides information about the settings used to run a transcription job.

Definition at line 718 of file CallAnalyticsJob.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::TranscribeService::Model::CallAnalyticsJob::GetStartTime ( ) const
inline

A timestamp that shows when the analytics job started processing.

Definition at line 294 of file CallAnalyticsJob.h.

◆ GetTranscript()

const Transcript& Aws::TranscribeService::Model::CallAnalyticsJob::GetTranscript ( ) const
inline

Definition at line 273 of file CallAnalyticsJob.h.

◆ IdentifiedLanguageScoreHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::IdentifiedLanguageScoreHasBeenSet ( ) const
inline

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

Definition at line 696 of file CallAnalyticsJob.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeService::Model::CallAnalyticsJob::Jsonize ( ) const

◆ LanguageCodeHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::LanguageCodeHasBeenSet ( ) const
inline

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 for additional information.

Definition at line 144 of file CallAnalyticsJob.h.

◆ MediaFormatHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::MediaFormatHasBeenSet ( ) const
inline

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.

Definition at line 226 of file CallAnalyticsJob.h.

◆ MediaHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::MediaHasBeenSet ( ) const
inline

Definition at line 257 of file CallAnalyticsJob.h.

◆ MediaSampleRateHertzHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::MediaSampleRateHertzHasBeenSet ( ) const
inline

The sample rate, in Hertz, of the audio.

Definition at line 203 of file CallAnalyticsJob.h.

◆ operator=()

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCallAnalyticsJobName() [1/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCallAnalyticsJobName ( Aws::String &&  value)
inline

The name of the call analytics job.

Definition at line 68 of file CallAnalyticsJob.h.

◆ SetCallAnalyticsJobName() [2/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCallAnalyticsJobName ( const Aws::String value)
inline

The name of the call analytics job.

Definition at line 63 of file CallAnalyticsJob.h.

◆ SetCallAnalyticsJobName() [3/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCallAnalyticsJobName ( const char *  value)
inline

The name of the call analytics job.

Definition at line 73 of file CallAnalyticsJob.h.

◆ SetCallAnalyticsJobStatus() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCallAnalyticsJobStatus ( CallAnalyticsJobStatus &&  value)
inline

The status of the analytics job.

Definition at line 109 of file CallAnalyticsJob.h.

◆ SetCallAnalyticsJobStatus() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCallAnalyticsJobStatus ( const CallAnalyticsJobStatus value)
inline

The status of the analytics job.

Definition at line 104 of file CallAnalyticsJob.h.

◆ SetChannelDefinitions() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetChannelDefinitions ( Aws::Vector< ChannelDefinition > &&  value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 768 of file CallAnalyticsJob.h.

◆ SetChannelDefinitions() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetChannelDefinitions ( const Aws::Vector< ChannelDefinition > &  value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 762 of file CallAnalyticsJob.h.

◆ SetCompletionTime() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCompletionTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job was completed.

Definition at line 371 of file CallAnalyticsJob.h.

◆ SetCompletionTime() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCompletionTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job was completed.

Definition at line 366 of file CallAnalyticsJob.h.

◆ SetCreationTime() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job was created.

Definition at line 340 of file CallAnalyticsJob.h.

◆ SetCreationTime() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job was created.

Definition at line 335 of file CallAnalyticsJob.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 651 of file CallAnalyticsJob.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 644 of file CallAnalyticsJob.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 658 of file CallAnalyticsJob.h.

◆ SetFailureReason() [1/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetFailureReason ( Aws::String &&  value)
inline

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.

Definition at line 502 of file CallAnalyticsJob.h.

◆ SetFailureReason() [2/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetFailureReason ( const Aws::String value)
inline

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.

Definition at line 472 of file CallAnalyticsJob.h.

◆ SetFailureReason() [3/3]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetFailureReason ( const char *  value)
inline

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.

Definition at line 532 of file CallAnalyticsJob.h.

◆ SetIdentifiedLanguageScore()

void Aws::TranscribeService::Model::CallAnalyticsJob::SetIdentifiedLanguageScore ( double  value)
inline

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

Definition at line 704 of file CallAnalyticsJob.h.

◆ SetLanguageCode() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetLanguageCode ( const LanguageCode value)
inline

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 for additional information.

Definition at line 156 of file CallAnalyticsJob.h.

◆ SetLanguageCode() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetLanguageCode ( LanguageCode &&  value)
inline

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 for additional information.

Definition at line 168 of file CallAnalyticsJob.h.

◆ SetMedia() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetMedia ( const Media value)
inline

Definition at line 260 of file CallAnalyticsJob.h.

◆ SetMedia() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetMedia ( Media &&  value)
inline

Definition at line 263 of file CallAnalyticsJob.h.

◆ SetMediaFormat() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetMediaFormat ( const MediaFormat value)
inline

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.

Definition at line 232 of file CallAnalyticsJob.h.

◆ SetMediaFormat() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetMediaFormat ( MediaFormat &&  value)
inline

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.

Definition at line 238 of file CallAnalyticsJob.h.

◆ SetMediaSampleRateHertz()

void Aws::TranscribeService::Model::CallAnalyticsJob::SetMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the audio.

Definition at line 208 of file CallAnalyticsJob.h.

◆ SetSettings() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetSettings ( CallAnalyticsJobSettings &&  value)
inline

Provides information about the settings used to run a transcription job.

Definition at line 733 of file CallAnalyticsJob.h.

◆ SetSettings() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetSettings ( const CallAnalyticsJobSettings value)
inline

Provides information about the settings used to run a transcription job.

Definition at line 728 of file CallAnalyticsJob.h.

◆ SetStartTime() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job started processing.

Definition at line 309 of file CallAnalyticsJob.h.

◆ SetStartTime() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetStartTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job started processing.

Definition at line 304 of file CallAnalyticsJob.h.

◆ SettingsHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::SettingsHasBeenSet ( ) const
inline

Provides information about the settings used to run a transcription job.

Definition at line 723 of file CallAnalyticsJob.h.

◆ SetTranscript() [1/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetTranscript ( const Transcript value)
inline

Definition at line 279 of file CallAnalyticsJob.h.

◆ SetTranscript() [2/2]

void Aws::TranscribeService::Model::CallAnalyticsJob::SetTranscript ( Transcript &&  value)
inline

Definition at line 282 of file CallAnalyticsJob.h.

◆ StartTimeHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::StartTimeHasBeenSet ( ) const
inline

A timestamp that shows when the analytics job started processing.

Definition at line 299 of file CallAnalyticsJob.h.

◆ TranscriptHasBeenSet()

bool Aws::TranscribeService::Model::CallAnalyticsJob::TranscriptHasBeenSet ( ) const
inline

Definition at line 276 of file CallAnalyticsJob.h.

◆ WithCallAnalyticsJobName() [1/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCallAnalyticsJobName ( Aws::String &&  value)
inline

The name of the call analytics job.

Definition at line 83 of file CallAnalyticsJob.h.

◆ WithCallAnalyticsJobName() [2/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCallAnalyticsJobName ( const Aws::String value)
inline

The name of the call analytics job.

Definition at line 78 of file CallAnalyticsJob.h.

◆ WithCallAnalyticsJobName() [3/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCallAnalyticsJobName ( const char *  value)
inline

The name of the call analytics job.

Definition at line 88 of file CallAnalyticsJob.h.

◆ WithCallAnalyticsJobStatus() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCallAnalyticsJobStatus ( CallAnalyticsJobStatus &&  value)
inline

The status of the analytics job.

Definition at line 119 of file CallAnalyticsJob.h.

◆ WithCallAnalyticsJobStatus() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCallAnalyticsJobStatus ( const CallAnalyticsJobStatus value)
inline

The status of the analytics job.

Definition at line 114 of file CallAnalyticsJob.h.

◆ WithChannelDefinitions() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithChannelDefinitions ( Aws::Vector< ChannelDefinition > &&  value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 780 of file CallAnalyticsJob.h.

◆ WithChannelDefinitions() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithChannelDefinitions ( const Aws::Vector< ChannelDefinition > &  value)
inline

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Definition at line 774 of file CallAnalyticsJob.h.

◆ WithCompletionTime() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCompletionTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job was completed.

Definition at line 381 of file CallAnalyticsJob.h.

◆ WithCompletionTime() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCompletionTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job was completed.

Definition at line 376 of file CallAnalyticsJob.h.

◆ WithCreationTime() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job was created.

Definition at line 350 of file CallAnalyticsJob.h.

◆ WithCreationTime() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job was created.

Definition at line 345 of file CallAnalyticsJob.h.

◆ WithDataAccessRoleArn() [1/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 672 of file CallAnalyticsJob.h.

◆ WithDataAccessRoleArn() [2/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 665 of file CallAnalyticsJob.h.

◆ WithDataAccessRoleArn() [3/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.

Definition at line 679 of file CallAnalyticsJob.h.

◆ WithFailureReason() [1/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithFailureReason ( Aws::String &&  value)
inline

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.

Definition at line 592 of file CallAnalyticsJob.h.

◆ WithFailureReason() [2/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithFailureReason ( const Aws::String value)
inline

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.

Definition at line 562 of file CallAnalyticsJob.h.

◆ WithFailureReason() [3/3]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithFailureReason ( const char *  value)
inline

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.

Definition at line 622 of file CallAnalyticsJob.h.

◆ WithIdentifiedLanguageScore()

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithIdentifiedLanguageScore ( double  value)
inline

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

Definition at line 712 of file CallAnalyticsJob.h.

◆ WithLanguageCode() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithLanguageCode ( const LanguageCode value)
inline

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 for additional information.

Definition at line 180 of file CallAnalyticsJob.h.

◆ WithLanguageCode() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithLanguageCode ( LanguageCode &&  value)
inline

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 for additional information.

Definition at line 192 of file CallAnalyticsJob.h.

◆ WithMedia() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithMedia ( const Media value)
inline

Definition at line 266 of file CallAnalyticsJob.h.

◆ WithMedia() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithMedia ( Media &&  value)
inline

Definition at line 269 of file CallAnalyticsJob.h.

◆ WithMediaFormat() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithMediaFormat ( const MediaFormat value)
inline

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.

Definition at line 244 of file CallAnalyticsJob.h.

◆ WithMediaFormat() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithMediaFormat ( MediaFormat &&  value)
inline

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.

Definition at line 250 of file CallAnalyticsJob.h.

◆ WithMediaSampleRateHertz()

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the audio.

Definition at line 213 of file CallAnalyticsJob.h.

◆ WithSettings() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithSettings ( CallAnalyticsJobSettings &&  value)
inline

Provides information about the settings used to run a transcription job.

Definition at line 743 of file CallAnalyticsJob.h.

◆ WithSettings() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithSettings ( const CallAnalyticsJobSettings value)
inline

Provides information about the settings used to run a transcription job.

Definition at line 738 of file CallAnalyticsJob.h.

◆ WithStartTime() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the analytics job started processing.

Definition at line 319 of file CallAnalyticsJob.h.

◆ WithStartTime() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithStartTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the analytics job started processing.

Definition at line 314 of file CallAnalyticsJob.h.

◆ WithTranscript() [1/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithTranscript ( const Transcript value)
inline

Definition at line 285 of file CallAnalyticsJob.h.

◆ WithTranscript() [2/2]

CallAnalyticsJob& Aws::TranscribeService::Model::CallAnalyticsJob::WithTranscript ( Transcript &&  value)
inline

Definition at line 288 of file CallAnalyticsJob.h.


The documentation for this class was generated from the following file: