libZSservicesZSamazonka-transcribeZSamazonka-transcribe
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transcribe.Types.CallAnalyticsJob

Description

 
Synopsis

Documentation

data CallAnalyticsJob Source #

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

See: newCallAnalyticsJob smart constructor.

Constructors

CallAnalyticsJob' 

Fields

  • creationTime :: Maybe POSIX

    A timestamp that shows when the analytics job was created.

  • failureReason :: Maybe Text

    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.
  • callAnalyticsJobStatus :: Maybe CallAnalyticsJobStatus

    The status of the analytics job.

  • identifiedLanguageScore :: Maybe Double

    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

  • languageCode :: Maybe LanguageCode

    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.

  • settings :: Maybe CallAnalyticsJobSettings

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

  • startTime :: Maybe POSIX

    A timestamp that shows when the analytics job started processing.

  • completionTime :: Maybe POSIX

    A timestamp that shows when the analytics job was completed.

  • callAnalyticsJobName :: Maybe Text

    The name of the call analytics job.

  • media :: Maybe Media
     
  • mediaFormat :: Maybe MediaFormat

    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.

  • channelDefinitions :: Maybe (NonEmpty ChannelDefinition)

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

  • dataAccessRoleArn :: Maybe Text

    The Amazon Resource Number (ARN) that you use to get access to the analytics job.

  • transcript :: Maybe Transcript
     
  • mediaSampleRateHertz :: Maybe Natural

    The sample rate, in Hertz, of the audio.

Instances

Instances details
Eq CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Read CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Show CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Generic CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Associated Types

type Rep CallAnalyticsJob :: Type -> Type #

NFData CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

rnf :: CallAnalyticsJob -> () #

Hashable CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

FromJSON CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

type Rep CallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

type Rep CallAnalyticsJob = D1 ('MetaData "CallAnalyticsJob" "Amazonka.Transcribe.Types.CallAnalyticsJob" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CallAnalyticsJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callAnalyticsJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobStatus)))) :*: ((S1 ('MetaSel ('Just "identifiedLanguageScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode))) :*: (S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobSettings)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: (((S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "callAnalyticsJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "media") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Media)) :*: S1 ('MetaSel ('Just "mediaFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MediaFormat)))) :*: ((S1 ('MetaSel ('Just "channelDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ChannelDefinition))) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "transcript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Transcript)) :*: S1 ('MetaSel ('Just "mediaSampleRateHertz") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))))

newCallAnalyticsJob :: CallAnalyticsJob Source #

Create a value of CallAnalyticsJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:CallAnalyticsJob', callAnalyticsJob_creationTime - A timestamp that shows when the analytics job was created.

$sel:failureReason:CallAnalyticsJob', callAnalyticsJob_failureReason - 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.

$sel:callAnalyticsJobStatus:CallAnalyticsJob', callAnalyticsJob_callAnalyticsJobStatus - The status of the analytics job.

$sel:identifiedLanguageScore:CallAnalyticsJob', callAnalyticsJob_identifiedLanguageScore - 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

$sel:languageCode:CallAnalyticsJob', callAnalyticsJob_languageCode - 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.

$sel:settings:CallAnalyticsJob', callAnalyticsJob_settings - Provides information about the settings used to run a transcription job.

$sel:startTime:CallAnalyticsJob', callAnalyticsJob_startTime - A timestamp that shows when the analytics job started processing.

$sel:completionTime:CallAnalyticsJob', callAnalyticsJob_completionTime - A timestamp that shows when the analytics job was completed.

$sel:callAnalyticsJobName:CallAnalyticsJob', callAnalyticsJob_callAnalyticsJobName - The name of the call analytics job.

$sel:media:CallAnalyticsJob', callAnalyticsJob_media - Undocumented member.

$sel:mediaFormat:CallAnalyticsJob', callAnalyticsJob_mediaFormat - 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.

$sel:channelDefinitions:CallAnalyticsJob', callAnalyticsJob_channelDefinitions - Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

$sel:dataAccessRoleArn:CallAnalyticsJob', callAnalyticsJob_dataAccessRoleArn - The Amazon Resource Number (ARN) that you use to get access to the analytics job.

$sel:transcript:CallAnalyticsJob', callAnalyticsJob_transcript - Undocumented member.

$sel:mediaSampleRateHertz:CallAnalyticsJob', callAnalyticsJob_mediaSampleRateHertz - The sample rate, in Hertz, of the audio.

callAnalyticsJob_creationTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

A timestamp that shows when the analytics job was created.

callAnalyticsJob_failureReason :: Lens' CallAnalyticsJob (Maybe Text) Source #

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.

callAnalyticsJob_identifiedLanguageScore :: Lens' CallAnalyticsJob (Maybe Double) Source #

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

callAnalyticsJob_languageCode :: Lens' CallAnalyticsJob (Maybe LanguageCode) Source #

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.

callAnalyticsJob_settings :: Lens' CallAnalyticsJob (Maybe CallAnalyticsJobSettings) Source #

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

callAnalyticsJob_startTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

A timestamp that shows when the analytics job started processing.

callAnalyticsJob_completionTime :: Lens' CallAnalyticsJob (Maybe UTCTime) Source #

A timestamp that shows when the analytics job was completed.

callAnalyticsJob_mediaFormat :: Lens' CallAnalyticsJob (Maybe MediaFormat) Source #

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.

callAnalyticsJob_channelDefinitions :: Lens' CallAnalyticsJob (Maybe (NonEmpty ChannelDefinition)) Source #

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

callAnalyticsJob_dataAccessRoleArn :: Lens' CallAnalyticsJob (Maybe Text) Source #

The Amazon Resource Number (ARN) that you use to get access to the analytics job.