Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Documentation

data CallAnalyticsJobSettings

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.

See: newCallAnalyticsJobSettings smart constructor.

Constructors

CallAnalyticsJobSettings'

Fields

• contentRedaction :: Maybe ContentRedaction
• languageIdSettings :: Maybe (HashMap LanguageCode LanguageIdSettings)

  If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

  LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

  It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

  If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

  For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

• languageModelName :: Maybe Text

  The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

  The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

• languageOptions :: Maybe (NonEmpty LanguageCode)

  You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

  Including language options can improve the accuracy of language identification.

  For a list of languages supported with Call Analytics, refer to the Supported languages table.

  To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

• vocabularyFilterMethod :: Maybe VocabularyFilterMethod

  Specify how you want your custom vocabulary filter applied to your transcript.

  To replace words with ***, choose mask.

  To delete words, choose remove.

  To flag words without changing them, choose tag.

• vocabularyFilterName :: Maybe Text

  The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

  Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

• vocabularyName :: Maybe Text

  The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

Instances

FromJSON CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

parseJSON :: Value -> Parser CallAnalyticsJobSettings

parseJSONList :: Value -> Parser [CallAnalyticsJobSettings]

ToJSON CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

toJSON :: CallAnalyticsJobSettings -> Value

toEncoding :: CallAnalyticsJobSettings -> Encoding

toJSONList :: [CallAnalyticsJobSettings] -> Value

toEncodingList :: [CallAnalyticsJobSettings] -> Encoding

Generic CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Associated Types

type Rep CallAnalyticsJobSettings :: Type -> Type

Methods

from :: CallAnalyticsJobSettings -> Rep CallAnalyticsJobSettings x

to :: Rep CallAnalyticsJobSettings x -> CallAnalyticsJobSettings

Read CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

readsPrec :: Int -> ReadS CallAnalyticsJobSettings

readList :: ReadS [CallAnalyticsJobSettings]

readPrec :: ReadPrec CallAnalyticsJobSettings

readListPrec :: ReadPrec [CallAnalyticsJobSettings]

Show CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

showsPrec :: Int -> CallAnalyticsJobSettings -> ShowS

show :: CallAnalyticsJobSettings -> String

showList :: [CallAnalyticsJobSettings] -> ShowS

NFData CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

rnf :: CallAnalyticsJobSettings -> ()

Eq CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

(==) :: CallAnalyticsJobSettings -> CallAnalyticsJobSettings -> Bool

(/=) :: CallAnalyticsJobSettings -> CallAnalyticsJobSettings -> Bool

Hashable CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

Methods

hashWithSalt :: Int -> CallAnalyticsJobSettings -> Int

hash :: CallAnalyticsJobSettings -> Int

type Rep CallAnalyticsJobSettings

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSettings

type Rep CallAnalyticsJobSettings = D1 ('MetaData "CallAnalyticsJobSettings" "Amazonka.Transcribe.Types.CallAnalyticsJobSettings" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "CallAnalyticsJobSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentRedaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentRedaction)) :*: (S1 ('MetaSel ('Just "languageIdSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LanguageCode LanguageIdSettings))) :*: S1 ('MetaSel ('Just "languageModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "languageOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty LanguageCode))) :*: S1 ('MetaSel ('Just "vocabularyFilterMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyFilterMethod))) :*: (S1 ('MetaSel ('Just "vocabularyFilterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCallAnalyticsJobSettings :: CallAnalyticsJobSettings

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:languageIdSettings:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageIdSettings - If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

CallAnalyticsJobSettings, callAnalyticsJobSettings_languageModelName - The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

$sel:languageOptions:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageOptions - You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

For a list of languages supported with Call Analytics, refer to the Supported languages table.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

$sel:vocabularyFilterMethod:CallAnalyticsJobSettings', callAnalyticsJobSettings_vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

CallAnalyticsJobSettings, callAnalyticsJobSettings_vocabularyFilterName - The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

CallAnalyticsJobSettings, callAnalyticsJobSettings_vocabularyName - The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.

callAnalyticsJobSettings_contentRedaction :: Lens' CallAnalyticsJobSettings (Maybe ContentRedaction)

Undocumented member.

callAnalyticsJobSettings_languageIdSettings :: Lens' CallAnalyticsJobSettings (Maybe (HashMap LanguageCode LanguageIdSettings))

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters.

For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.

callAnalyticsJobSettings_languageModelName :: Lens' CallAnalyticsJobSettings (Maybe Text)

The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.

The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

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

You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

For a list of languages supported with Call Analytics, refer to the Supported languages table.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

callAnalyticsJobSettings_vocabularyFilterMethod :: Lens' CallAnalyticsJobSettings (Maybe VocabularyFilterMethod)

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

callAnalyticsJobSettings_vocabularyFilterName :: Lens' CallAnalyticsJobSettings (Maybe Text)

The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

callAnalyticsJobSettings_vocabularyName :: Lens' CallAnalyticsJobSettings (Maybe Text)

The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.