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 |
Creates a new custom vocabulary filter.
You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Vocabulary filtering.
Synopsis
- data CreateVocabularyFilter = CreateVocabularyFilter' {}
- newCreateVocabularyFilter :: Text -> LanguageCode -> CreateVocabularyFilter
- createVocabularyFilter_tags :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Tag))
- createVocabularyFilter_vocabularyFilterFileUri :: Lens' CreateVocabularyFilter (Maybe Text)
- createVocabularyFilter_words :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Text))
- createVocabularyFilter_vocabularyFilterName :: Lens' CreateVocabularyFilter Text
- createVocabularyFilter_languageCode :: Lens' CreateVocabularyFilter LanguageCode
- data CreateVocabularyFilterResponse = CreateVocabularyFilterResponse' {}
- newCreateVocabularyFilterResponse :: Int -> CreateVocabularyFilterResponse
- createVocabularyFilterResponse_languageCode :: Lens' CreateVocabularyFilterResponse (Maybe LanguageCode)
- createVocabularyFilterResponse_lastModifiedTime :: Lens' CreateVocabularyFilterResponse (Maybe UTCTime)
- createVocabularyFilterResponse_vocabularyFilterName :: Lens' CreateVocabularyFilterResponse (Maybe Text)
- createVocabularyFilterResponse_httpStatus :: Lens' CreateVocabularyFilterResponse Int
Creating a Request
data CreateVocabularyFilter Source #
See: newCreateVocabularyFilter
smart constructor.
CreateVocabularyFilter' | |
|
Instances
newCreateVocabularyFilter Source #
Create a value of CreateVocabularyFilter
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:
CreateVocabularyFilter
, createVocabularyFilter_tags
- Adds one or more custom tags, each in the form of a key:value pair, to a
new custom vocabulary filter at the time you create this new vocabulary
filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
$sel:vocabularyFilterFileUri:CreateVocabularyFilter'
, createVocabularyFilter_vocabularyFilterFileUri
- The Amazon S3 location of the text file that contains your custom
vocabulary filter terms. The URI must be located in the same Amazon Web
Services Region as the resource you're calling.
Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you
cannot use Words
; you must choose one or the other.
$sel:words:CreateVocabularyFilter'
, createVocabularyFilter_words
- Use this parameter if you want to create your custom vocabulary filter
by including all desired terms, as comma-separated values, within your
request. The other option for creating your vocabulary filter is to save
your entries in a text file and upload them to an Amazon S3 bucket, then
specify the location of your file using the VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
CreateVocabularyFilter
, createVocabularyFilter_vocabularyFilterName
- A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new custom
vocabulary filter with the same name as an existing custom vocabulary
filter, you get a ConflictException
error.
CreateVocabularyFilter
, createVocabularyFilter_languageCode
- The language code that represents the language of the entries in your
vocabulary filter. Each custom vocabulary filter must contain terms in
only one language.
A custom vocabulary filter can only be used to transcribe files in the
same language as the filter. For example, if you create a custom
vocabulary filter using US English (en-US
), you can only apply this
filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
Request Lenses
createVocabularyFilter_tags :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Tag)) Source #
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
createVocabularyFilter_vocabularyFilterFileUri :: Lens' CreateVocabularyFilter (Maybe Text) Source #
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you
cannot use Words
; you must choose one or the other.
createVocabularyFilter_words :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Text)) Source #
Use this parameter if you want to create your custom vocabulary filter
by including all desired terms, as comma-separated values, within your
request. The other option for creating your vocabulary filter is to save
your entries in a text file and upload them to an Amazon S3 bucket, then
specify the location of your file using the VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
createVocabularyFilter_vocabularyFilterName :: Lens' CreateVocabularyFilter Text Source #
A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique
within an Amazon Web Services account. If you try to create a new custom
vocabulary filter with the same name as an existing custom vocabulary
filter, you get a ConflictException
error.
createVocabularyFilter_languageCode :: Lens' CreateVocabularyFilter LanguageCode Source #
The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.
A custom vocabulary filter can only be used to transcribe files in the
same language as the filter. For example, if you create a custom
vocabulary filter using US English (en-US
), you can only apply this
filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
Destructuring the Response
data CreateVocabularyFilterResponse Source #
See: newCreateVocabularyFilterResponse
smart constructor.
CreateVocabularyFilterResponse' | |
|
Instances
newCreateVocabularyFilterResponse Source #
Create a value of CreateVocabularyFilterResponse
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:
CreateVocabularyFilter
, createVocabularyFilterResponse_languageCode
- The language code you selected for your custom vocabulary filter.
CreateVocabularyFilterResponse
, createVocabularyFilterResponse_lastModifiedTime
- The date and time you created your custom vocabulary filter.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.761000-07:00
represents 12:32 PM UTC-7 on
May 4, 2022.
CreateVocabularyFilter
, createVocabularyFilterResponse_vocabularyFilterName
- The name you chose for your custom vocabulary filter.
$sel:httpStatus:CreateVocabularyFilterResponse'
, createVocabularyFilterResponse_httpStatus
- The response's http status code.
Response Lenses
createVocabularyFilterResponse_languageCode :: Lens' CreateVocabularyFilterResponse (Maybe LanguageCode) Source #
The language code you selected for your custom vocabulary filter.
createVocabularyFilterResponse_lastModifiedTime :: Lens' CreateVocabularyFilterResponse (Maybe UTCTime) Source #
The date and time you created your custom vocabulary filter.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For
example, 2022-05-04T12:32:58.761000-07:00
represents 12:32 PM UTC-7 on
May 4, 2022.
createVocabularyFilterResponse_vocabularyFilterName :: Lens' CreateVocabularyFilterResponse (Maybe Text) Source #
The name you chose for your custom vocabulary filter.
createVocabularyFilterResponse_httpStatus :: Lens' CreateVocabularyFilterResponse Int Source #
The response's http status code.