/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; /** *

* 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. *

*/ public class CallAnalyticsJobSettings implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String vocabularyName; /** *

* 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String vocabularyFilterName; /** *

* 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. *

*

* Constraints:
* Allowed Values: remove, mask, tag */ private String vocabularyFilterMethod; /** *

* 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String languageModelName; /** *

* Makes it possible to redact or flag specified personally identifiable * information (PII) in your transcript. If you use * ContentRedaction, you must also include the sub-parameters: * PiiEntityTypes, RedactionOutput, and * RedactionType. *

*/ private ContentRedaction contentRedaction; /** *

* 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. *

*/ private java.util.List languageOptions; /** *

* 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. *

*/ private java.util.Map languageIdSettings; /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

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

*/ public String getVocabularyName() { return vocabularyName; } /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param vocabularyName

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

*/ public void setVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; } /** *

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

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param vocabularyName

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

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; return this; } /** *

* 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

* 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. *

*/ public String getVocabularyFilterName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setVocabularyFilterName(String vocabularyFilterName) { this.vocabularyFilterName = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withVocabularyFilterName(String vocabularyFilterName) { this.vocabularyFilterName = vocabularyFilterName; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: remove, mask, tag * * @return

* 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. *

* @see VocabularyFilterMethod */ public String getVocabularyFilterMethod() { return 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. *

*

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @see VocabularyFilterMethod */ public void setVocabularyFilterMethod(String vocabularyFilterMethod) { this.vocabularyFilterMethod = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyFilterMethod */ public CallAnalyticsJobSettings withVocabularyFilterMethod(String vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @see VocabularyFilterMethod */ public void setVocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod.toString(); } /** *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: remove, mask, tag * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VocabularyFilterMethod */ public CallAnalyticsJobSettings withVocabularyFilterMethod( VocabularyFilterMethod vocabularyFilterMethod) { this.vocabularyFilterMethod = vocabularyFilterMethod.toString(); return this; } /** *

* 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

* 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. *

*/ public String getLanguageModelName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setLanguageModelName(String languageModelName) { this.languageModelName = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withLanguageModelName(String languageModelName) { this.languageModelName = languageModelName; return this; } /** *

* Makes it possible to redact or flag specified personally identifiable * information (PII) in your transcript. If you use * ContentRedaction, you must also include the sub-parameters: * PiiEntityTypes, RedactionOutput, and * RedactionType. *

* * @return

* Makes it possible to redact or flag specified personally * identifiable information (PII) in your transcript. If you use * ContentRedaction, you must also include the * sub-parameters: PiiEntityTypes, * RedactionOutput, and RedactionType. *

*/ public ContentRedaction getContentRedaction() { return contentRedaction; } /** *

* Makes it possible to redact or flag specified personally identifiable * information (PII) in your transcript. If you use * ContentRedaction, you must also include the sub-parameters: * PiiEntityTypes, RedactionOutput, and * RedactionType. *

* * @param contentRedaction

* Makes it possible to redact or flag specified personally * identifiable information (PII) in your transcript. If you use * ContentRedaction, you must also include the * sub-parameters: PiiEntityTypes, * RedactionOutput, and RedactionType. *

*/ public void setContentRedaction(ContentRedaction contentRedaction) { this.contentRedaction = contentRedaction; } /** *

* Makes it possible to redact or flag specified personally identifiable * information (PII) in your transcript. If you use * ContentRedaction, you must also include the sub-parameters: * PiiEntityTypes, RedactionOutput, and * RedactionType. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param contentRedaction

* Makes it possible to redact or flag specified personally * identifiable information (PII) in your transcript. If you use * ContentRedaction, you must also include the * sub-parameters: PiiEntityTypes, * RedactionOutput, and RedactionType. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withContentRedaction(ContentRedaction contentRedaction) { this.contentRedaction = contentRedaction; return this; } /** *

* 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. *

* * @return

* 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. *

*/ public java.util.List getLanguageOptions() { return 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. *

* * @param 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. *

*/ public void setLanguageOptions(java.util.Collection languageOptions) { if (languageOptions == null) { this.languageOptions = null; return; } this.languageOptions = new java.util.ArrayList(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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withLanguageOptions(String... languageOptions) { if (getLanguageOptions() == null) { this.languageOptions = new java.util.ArrayList(languageOptions.length); } for (String value : languageOptions) { this.languageOptions.add(value); } return this; } /** *

* 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withLanguageOptions(java.util.Collection languageOptions) { setLanguageOptions(languageOptions); return this; } /** *

* 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. *

* * @return

* 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. *

*/ public java.util.Map getLanguageIdSettings() { return 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. *

* * @param 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. *

*/ public void setLanguageIdSettings(java.util.Map languageIdSettings) { this.languageIdSettings = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings withLanguageIdSettings( java.util.Map languageIdSettings) { this.languageIdSettings = languageIdSettings; return this; } /** *

* 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. *

*

* The method adds a new key-value pair into LanguageIdSettings parameter, * and returns a reference to this object so that method calls can be * chained together. * * @param key The key of the entry to be added into LanguageIdSettings. * @param value The corresponding value of the entry to be added into * LanguageIdSettings. * @return A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSettings addLanguageIdSettingsEntry(String key, LanguageIdSettings value) { if (null == this.languageIdSettings) { this.languageIdSettings = new java.util.HashMap(); } if (this.languageIdSettings.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.languageIdSettings.put(key, value); return this; } /** * Removes all the entries added into LanguageIdSettings. *

* Returns a reference to this object so that method calls can be chained * together. */ public CallAnalyticsJobSettings clearLanguageIdSettingsEntries() { this.languageIdSettings = null; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getVocabularyName() != null) sb.append("VocabularyName: " + getVocabularyName() + ","); if (getVocabularyFilterName() != null) sb.append("VocabularyFilterName: " + getVocabularyFilterName() + ","); if (getVocabularyFilterMethod() != null) sb.append("VocabularyFilterMethod: " + getVocabularyFilterMethod() + ","); if (getLanguageModelName() != null) sb.append("LanguageModelName: " + getLanguageModelName() + ","); if (getContentRedaction() != null) sb.append("ContentRedaction: " + getContentRedaction() + ","); if (getLanguageOptions() != null) sb.append("LanguageOptions: " + getLanguageOptions() + ","); if (getLanguageIdSettings() != null) sb.append("LanguageIdSettings: " + getLanguageIdSettings()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode()); hashCode = prime * hashCode + ((getVocabularyFilterName() == null) ? 0 : getVocabularyFilterName().hashCode()); hashCode = prime * hashCode + ((getVocabularyFilterMethod() == null) ? 0 : getVocabularyFilterMethod() .hashCode()); hashCode = prime * hashCode + ((getLanguageModelName() == null) ? 0 : getLanguageModelName().hashCode()); hashCode = prime * hashCode + ((getContentRedaction() == null) ? 0 : getContentRedaction().hashCode()); hashCode = prime * hashCode + ((getLanguageOptions() == null) ? 0 : getLanguageOptions().hashCode()); hashCode = prime * hashCode + ((getLanguageIdSettings() == null) ? 0 : getLanguageIdSettings().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CallAnalyticsJobSettings == false) return false; CallAnalyticsJobSettings other = (CallAnalyticsJobSettings) obj; if (other.getVocabularyName() == null ^ this.getVocabularyName() == null) return false; if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == false) return false; if (other.getVocabularyFilterName() == null ^ this.getVocabularyFilterName() == null) return false; if (other.getVocabularyFilterName() != null && other.getVocabularyFilterName().equals(this.getVocabularyFilterName()) == false) return false; if (other.getVocabularyFilterMethod() == null ^ this.getVocabularyFilterMethod() == null) return false; if (other.getVocabularyFilterMethod() != null && other.getVocabularyFilterMethod().equals(this.getVocabularyFilterMethod()) == false) return false; if (other.getLanguageModelName() == null ^ this.getLanguageModelName() == null) return false; if (other.getLanguageModelName() != null && other.getLanguageModelName().equals(this.getLanguageModelName()) == false) return false; if (other.getContentRedaction() == null ^ this.getContentRedaction() == null) return false; if (other.getContentRedaction() != null && other.getContentRedaction().equals(this.getContentRedaction()) == false) return false; if (other.getLanguageOptions() == null ^ this.getLanguageOptions() == null) return false; if (other.getLanguageOptions() != null && other.getLanguageOptions().equals(this.getLanguageOptions()) == false) return false; if (other.getLanguageIdSettings() == null ^ this.getLanguageIdSettings() == null) return false; if (other.getLanguageIdSettings() != null && other.getLanguageIdSettings().equals(this.getLanguageIdSettings()) == false) return false; return true; } }