AWSTranscribeCallAnalyticsJob

Objective-C

@interface AWSTranscribeCallAnalyticsJob

Swift

class AWSTranscribeCallAnalyticsJob

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

  • The name of the call analytics job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable callAnalyticsJobName;

    Swift

    var callAnalyticsJobName: String? { get set }
  • The status of the analytics job.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeCallAnalyticsJobStatus callAnalyticsJobStatus;

    Swift

    var callAnalyticsJobStatus: AWSTranscribeCallAnalyticsJobStatus { get set }
  • Shows numeric values to indicate the channel assigned to the agent’s audio and the channel assigned to the customer’s audio.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTranscribeChannelDefinition *> *_Nullable channelDefinitions;

    Swift

    var channelDefinitions: [AWSTranscribeChannelDefinition]? { get set }
  • A timestamp that shows when the analytics job was completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable completionTime;

    Swift

    var completionTime: Date? { get set }
  • A timestamp that shows when the analytics job was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationTime;

    Swift

    var creationTime: Date? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable failureReason;

    Swift

    var failureReason: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable identifiedLanguageScore;

    Swift

    var identifiedLanguageScore: NSNumber? { get set }
  • 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 for additional information.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeLanguageCode { get set }
  • Describes the input media file in a transcription request.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedia *_Nullable media;

    Swift

    var media: AWSTranscribeMedia? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMediaFormat mediaFormat;

    Swift

    var mediaFormat: AWSTranscribeMediaFormat { get set }
  • The sample rate, in Hertz, of the audio.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable mediaSampleRateHertz;

    Swift

    var mediaSampleRateHertz: NSNumber? { get set }
  • Provides information about the settings used to run a transcription job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeCallAnalyticsJobSettings *_Nullable settings;

    Swift

    var settings: AWSTranscribeCallAnalyticsJobSettings? { get set }
  • A timestamp that shows when the analytics job started processing.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }
  • Identifies the location of a transcription.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeTranscript *_Nullable transcript;

    Swift

    var transcript: AWSTranscribeTranscript? { get set }