Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Description

Synopsis

Documentation

data CallAnalyticsJobSettings Source #

Provides optional settings for the CallAnalyticsJob operation.

See: newCallAnalyticsJobSettings smart constructor.

Constructors

CallAnalyticsJobSettings'

Fields

contentRedaction :: Maybe ContentRedaction
languageOptions :: Maybe (NonEmpty LanguageCode)
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
vocabularyName :: Maybe Text
The name of a vocabulary to use when processing the call analytics job.
languageModelName :: Maybe Text
The structure used to describe a custom language model.
vocabularyFilterName :: Maybe Text
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
vocabularyFilterMethod :: Maybe VocabularyFilterMethod
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Instances

Instances details

Eq CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods (==) :: CallAnalyticsJobSettings -> CallAnalyticsJobSettings -> Bool # (/=) :: CallAnalyticsJobSettings -> CallAnalyticsJobSettings -> Bool #
Read CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods readsPrec :: Int -> ReadS CallAnalyticsJobSettings # readList :: ReadS [CallAnalyticsJobSettings] # readPrec :: ReadPrec CallAnalyticsJobSettings # readListPrec :: ReadPrec [CallAnalyticsJobSettings] #
Show CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods showsPrec :: Int -> CallAnalyticsJobSettings -> ShowS # show :: CallAnalyticsJobSettings -> String # showList :: [CallAnalyticsJobSettings] -> ShowS #
Generic CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Associated Types type Rep CallAnalyticsJobSettings :: Type -> Type # Methods from :: CallAnalyticsJobSettings -> Rep CallAnalyticsJobSettings x # to :: Rep CallAnalyticsJobSettings x -> CallAnalyticsJobSettings #
NFData CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods rnf :: CallAnalyticsJobSettings -> () #
Hashable CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods hashWithSalt :: Int -> CallAnalyticsJobSettings -> Int # hash :: CallAnalyticsJobSettings -> Int #
ToJSON CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods toJSON :: CallAnalyticsJobSettings -> Value # toEncoding :: CallAnalyticsJobSettings -> Encoding # toJSONList :: [CallAnalyticsJobSettings] -> Value # toEncodingList :: [CallAnalyticsJobSettings] -> Encoding #
FromJSON CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings Methods parseJSON :: Value -> Parser CallAnalyticsJobSettings # parseJSONList :: Value -> Parser [CallAnalyticsJobSettings] #
type Rep CallAnalyticsJobSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings type Rep CallAnalyticsJobSettings = D1 ('MetaData "CallAnalyticsJobSettings" "Amazonka.Transcribe.Types.CallAnalyticsJobSettings" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CallAnalyticsJobSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentRedaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentRedaction)) :: (S1 ('MetaSel ('Just "languageOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty LanguageCode))) :: S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "languageModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vocabularyFilterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vocabularyFilterMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyFilterMethod))))))

newCallAnalyticsJobSettings :: CallAnalyticsJobSettings Source #

Create a value of CallAnalyticsJobSettings 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:contentRedaction:CallAnalyticsJobSettings', callAnalyticsJobSettings_contentRedaction - Undocumented member.

$sel:languageOptions:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageOptions - When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.

To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.

$sel:vocabularyName:CallAnalyticsJobSettings', callAnalyticsJobSettings_vocabularyName - The name of a vocabulary to use when processing the call analytics job.

$sel:languageModelName:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageModelName - The structure used to describe a custom language model.

$sel:vocabularyFilterName:CallAnalyticsJobSettings', callAnalyticsJobSettings_vocabularyFilterName - The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.

$sel:vocabularyFilterMethod:CallAnalyticsJobSettings', callAnalyticsJobSettings_vocabularyFilterMethod - Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

callAnalyticsJobSettings_contentRedaction :: Lens' CallAnalyticsJobSettings (Maybe ContentRedaction) Source #

Undocumented member.

callAnalyticsJobSettings_languageOptions :: Lens' CallAnalyticsJobSettings (Maybe (NonEmpty LanguageCode)) Source #

When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.

To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.

callAnalyticsJobSettings_vocabularyName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

The name of a vocabulary to use when processing the call analytics job.

callAnalyticsJobSettings_languageModelName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

The structure used to describe a custom language model.

callAnalyticsJobSettings_vocabularyFilterName :: Lens' CallAnalyticsJobSettings (Maybe Text) Source #

The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.

callAnalyticsJobSettings_vocabularyFilterMethod :: Lens' CallAnalyticsJobSettings (Maybe VocabularyFilterMethod) Source #

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.