Interface EngineTranscribeSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>, SdkBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>, SdkPojo
Enclosing class:
EngineTranscribeSettings
@Mutable @NotThreadSafe public static interface EngineTranscribeSettings.Builder extends SdkPojo, CopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>

  • Method Details

    • languageCode

      EngineTranscribeSettings.Builder languageCode(String languageCode)

      Specify the language code that represents the language spoken.

      If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

      Parameters:
      languageCode - Specify the language code that represents the language spoken.

      If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      EngineTranscribeSettings.Builder languageCode(TranscribeLanguageCode languageCode)

      Specify the language code that represents the language spoken.

      If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

      Parameters:
      languageCode - Specify the language code that represents the language spoken.

      If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyFilterMethod

      EngineTranscribeSettings.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

      Specify how you want your 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.

      Parameters:
      vocabularyFilterMethod - Specify how you want your 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyFilterMethod

      EngineTranscribeSettings.Builder vocabularyFilterMethod(TranscribeVocabularyFilterMethod vocabularyFilterMethod)

      Specify how you want your 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.

      Parameters:
      vocabularyFilterMethod - Specify how you want your 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyFilterName

      EngineTranscribeSettings.Builder vocabularyFilterName(String vocabularyFilterName)

      Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

      If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

      Parameters:
      vocabularyFilterName - Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

      If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.

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

    • vocabularyName

      EngineTranscribeSettings.Builder vocabularyName(String vocabularyName)

      Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

      If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

      If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

      Parameters:
      vocabularyName - Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

      If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

      If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.

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

    • region

      EngineTranscribeSettings.Builder region(String region)

      The Amazon Web Services Region in which to use Amazon Transcribe.

      If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

      Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

      Parameters:
      region - The Amazon Web Services Region in which to use Amazon Transcribe.

      If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

      Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion . For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • region

      EngineTranscribeSettings.Builder region(TranscribeRegion region)

      The Amazon Web Services Region in which to use Amazon Transcribe.

      If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

      Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

      Parameters:
      region - The Amazon Web Services Region in which to use Amazon Transcribe.

      If you don't specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.

      Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion . For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enablePartialResultsStabilization

      EngineTranscribeSettings.Builder enablePartialResultsStabilization(Boolean enablePartialResultsStabilization)

      Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

      Parameters:
      enablePartialResultsStabilization - Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partialResultsStability

      EngineTranscribeSettings.Builder partialResultsStability(String partialResultsStability)

      Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).

      Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

      Parameters:
      partialResultsStability - Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).

      Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • partialResultsStability

      EngineTranscribeSettings.Builder partialResultsStability(TranscribePartialResultsStability partialResultsStability)

      Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).

      Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

      Parameters:
      partialResultsStability - Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).

      Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentIdentificationType

      EngineTranscribeSettings.Builder contentIdentificationType(String contentIdentificationType)

      Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

      You can’t set ContentIdentificationType and ContentRedactionType.

      Parameters:
      contentIdentificationType - Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

      You can’t set ContentIdentificationType and ContentRedactionType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentIdentificationType

      EngineTranscribeSettings.Builder contentIdentificationType(TranscribeContentIdentificationType contentIdentificationType)

      Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

      You can’t set ContentIdentificationType and ContentRedactionType.

      Parameters:
      contentIdentificationType - Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.

      You can’t set ContentIdentificationType and ContentRedactionType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentRedactionType

      EngineTranscribeSettings.Builder contentRedactionType(String contentRedactionType)

      Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

      You can’t set ContentRedactionType and ContentIdentificationType.

      Parameters:
      contentRedactionType - Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

      You can’t set ContentRedactionType and ContentIdentificationType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentRedactionType

      EngineTranscribeSettings.Builder contentRedactionType(TranscribeContentRedactionType contentRedactionType)

      Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

      You can’t set ContentRedactionType and ContentIdentificationType.

      Parameters:
      contentRedactionType - Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.

      You can’t set ContentRedactionType and ContentIdentificationType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • piiEntityTypes

      EngineTranscribeSettings.Builder piiEntityTypes(String piiEntityTypes)

      Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

      Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

      Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

      If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

      Parameters:
      piiEntityTypes - Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

      Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL,NAME, PHONE, PIN, SSN, or ALL.

      Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.

      If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.

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

    • languageModelName

      EngineTranscribeSettings.Builder languageModelName(String languageModelName)

      Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

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

      If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

      Parameters:
      languageModelName - Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

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

      If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.

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

    • identifyLanguage

      EngineTranscribeSettings.Builder identifyLanguage(Boolean identifyLanguage)

      Enables automatic language identification for your transcription.

      If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

      You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

      You must include either LanguageCode or IdentifyLanguage.

      Language identification can't be combined with custom language models or redaction.

      Parameters:
      identifyLanguage - Enables automatic language identification for your transcription.

      If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.

      You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.

      You must include either LanguageCode or IdentifyLanguage.

      Language identification can't be combined with custom language models or redaction.

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

    • languageOptions

      EngineTranscribeSettings.Builder languageOptions(String languageOptions)

      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.

      If you include LanguageOptions, you must also include IdentifyLanguage.

      You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

      Parameters:
      languageOptions - 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.

      If you include LanguageOptions, you must also include IdentifyLanguage.

      You can only include one language dialect per language. For example, you cannot include en-US and en-AU.

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

    • preferredLanguage

      EngineTranscribeSettings.Builder preferredLanguage(String preferredLanguage)

      Specify a preferred language from the subset of languages codes you specified in LanguageOptions .

      You can only use this parameter if you include IdentifyLanguage and LanguageOptions .

      Parameters:
      preferredLanguage - Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

      You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • preferredLanguage

      EngineTranscribeSettings.Builder preferredLanguage(TranscribeLanguageCode preferredLanguage)

      Specify a preferred language from the subset of languages codes you specified in LanguageOptions .

      You can only use this parameter if you include IdentifyLanguage and LanguageOptions .

      Parameters:
      preferredLanguage - Specify a preferred language from the subset of languages codes you specified in LanguageOptions.

      You can only use this parameter if you include IdentifyLanguage and LanguageOptions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vocabularyNames

      EngineTranscribeSettings.Builder vocabularyNames(String vocabularyNames)

      Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

      If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

      Parameters:
      vocabularyNames - Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.

      If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.

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

    • vocabularyFilterNames

      EngineTranscribeSettings.Builder vocabularyFilterNames(String vocabularyFilterNames)

      Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

      If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

      Parameters:
      vocabularyFilterNames - Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

      If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.

      If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.

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