| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Transcribe.Types.LanguageIdSettings
Description
Synopsis
- data LanguageIdSettings = LanguageIdSettings' {}
- newLanguageIdSettings :: LanguageIdSettings
- languageIdSettings_languageModelName :: Lens' LanguageIdSettings (Maybe Text)
- languageIdSettings_vocabularyFilterName :: Lens' LanguageIdSettings (Maybe Text)
- languageIdSettings_vocabularyName :: Lens' LanguageIdSettings (Maybe Text)
Documentation
data LanguageIdSettings Source #
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). Note that multi-language identification
(IdentifyMultipleLanguages) doesn't support custom language models.
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 with your request but
do not want to use automatic language identification, use instead
the parameter with the LanguageModelName sub-parameter. If you want to
include a custom vocabulary or a custom vocabulary filter (or both) with
your request but do not want to use automatic language
identification, use instead the parameter with the VocabularyName or
VocabularyFilterName (or both) sub-parameter.
See: newLanguageIdSettings smart constructor.
Constructors
| LanguageIdSettings' | |
Fields
| |
Instances
newLanguageIdSettings :: LanguageIdSettings Source #
Create a value of LanguageIdSettings 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:languageModelName:LanguageIdSettings', languageIdSettings_languageModelName - The name of the custom language model you want to use when processing
your transcription 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:vocabularyFilterName:LanguageIdSettings', languageIdSettings_vocabularyFilterName - The name of the custom vocabulary filter you want to use when processing
your transcription job. Custom vocabulary filter names are case
sensitive.
The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include VocabularyFilterName in your request, you
must also include VocabularyFilterMethod.
$sel:vocabularyName:LanguageIdSettings', languageIdSettings_vocabularyName - The name of the custom vocabulary you want to use when processing your
transcription job. Custom vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
languageIdSettings_languageModelName :: Lens' LanguageIdSettings (Maybe Text) Source #
The name of the custom language model you want to use when processing your transcription 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.
languageIdSettings_vocabularyFilterName :: Lens' LanguageIdSettings (Maybe Text) Source #
The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive.
The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include VocabularyFilterName in your request, you
must also include VocabularyFilterMethod.
languageIdSettings_vocabularyName :: Lens' LanguageIdSettings (Maybe Text) Source #
The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.