/* * 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; /** *

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

*/ public class LanguageIdSettings implements Serializable { /** *

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

*

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

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

*

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

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

*

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

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

*

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

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

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

*

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

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

*

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

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

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

*

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

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

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

*

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

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

*

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

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

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

*

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

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

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

*

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

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

*

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

* @return A reference to this updated object so that method calls can be * chained together. */ public LanguageIdSettings withLanguageModelName(String languageModelName) { this.languageModelName = languageModelName; 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 (getLanguageModelName() != null) sb.append("LanguageModelName: " + getLanguageModelName()); 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 + ((getLanguageModelName() == null) ? 0 : getLanguageModelName().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof LanguageIdSettings == false) return false; LanguageIdSettings other = (LanguageIdSettings) 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.getLanguageModelName() == null ^ this.getLanguageModelName() == null) return false; if (other.getLanguageModelName() != null && other.getLanguageModelName().equals(this.getLanguageModelName()) == false) return false; return true; } }