/AWS1/CL_CHMENGINETRANSCRIBE00

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_languagecode TYPE /AWS1/CHMTRANSCRIBELANGUAGEC00 /AWS1/CHMTRANSCRIBELANGUAGEC00

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.

iv_vocabularyfiltermethod TYPE /AWS1/CHMTRANSCRIBEVOCABULAR00 /AWS1/CHMTRANSCRIBEVOCABULAR00

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.

iv_vocabularyfiltername TYPE /AWS1/CHMSTRING /AWS1/CHMSTRING

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.

iv_vocabularyname TYPE /AWS1/CHMSTRING /AWS1/CHMSTRING

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.

iv_region TYPE /AWS1/CHMTRANSCRIBEREGION /AWS1/CHMTRANSCRIBEREGION

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.

iv_enbpartialrsltsstabiliz00 TYPE /AWS1/CHMBOOLEAN /AWS1/CHMBOOLEAN

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

iv_partialresultsstability TYPE /AWS1/CHMTRANSCRIBEPARTIALRS00 /AWS1/CHMTRANSCRIBEPARTIALRS00

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.

iv_contentidentificationtype TYPE /AWS1/CHMTRANSCRIBECONTIDENT00 /AWS1/CHMTRANSCRIBECONTIDENT00

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.

iv_contentredactiontype TYPE /AWS1/CHMTRANSCRIBECONTREDAC00 /AWS1/CHMTRANSCRIBECONTREDAC00

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.

iv_piientitytypes TYPE /AWS1/CHMTRANSCRIBEPIIENTTYPES /AWS1/CHMTRANSCRIBEPIIENTTYPES

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.

iv_languagemodelname TYPE /AWS1/CHMTRANSCRIBELANGUAGEM00 /AWS1/CHMTRANSCRIBELANGUAGEM00

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.

iv_identifylanguage TYPE /AWS1/CHMBOOLEAN /AWS1/CHMBOOLEAN

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.

iv_languageoptions TYPE /AWS1/CHMTRANSCRIBELANGUAGEO00 /AWS1/CHMTRANSCRIBELANGUAGEO00

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.

iv_preferredlanguage TYPE /AWS1/CHMTRANSCRIBELANGUAGEC00 /AWS1/CHMTRANSCRIBELANGUAGEC00

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.

iv_vocabularynames TYPE /AWS1/CHMTRANSCRIBEVOCABULAR01 /AWS1/CHMTRANSCRIBEVOCABULAR01

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.

iv_vocabularyfilternames TYPE /AWS1/CHMTRANSCRIBEVOCABULAR01 /AWS1/CHMTRANSCRIBEVOCABULAR01

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.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_LANGUAGECODE()	Getter for LANGUAGECODE, with configurable default
ASK_LANGUAGECODE()	Getter for LANGUAGECODE w/ exceptions if field has no value
HAS_LANGUAGECODE()	Determine if LANGUAGECODE has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYFILTERMETHOD()	Getter for VOCABULARYFILTERMETHOD, with configurable default
ASK_VOCABULARYFILTERMETHOD()	Getter for VOCABULARYFILTERMETHOD w/ exceptions if field has
HAS_VOCABULARYFILTERMETHOD()	Determine if VOCABULARYFILTERMETHOD has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYFILTERNAME()	Getter for VOCABULARYFILTERNAME, with configurable default
ASK_VOCABULARYFILTERNAME()	Getter for VOCABULARYFILTERNAME w/ exceptions if field has n
HAS_VOCABULARYFILTERNAME()	Determine if VOCABULARYFILTERNAME has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYNAME()	Getter for VOCABULARYNAME, with configurable default
ASK_VOCABULARYNAME()	Getter for VOCABULARYNAME w/ exceptions if field has no valu
HAS_VOCABULARYNAME()	Determine if VOCABULARYNAME has a value

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.

Accessible with the following methods

Method	Description
GET_REGION()	Getter for REGION, with configurable default
ASK_REGION()	Getter for REGION w/ exceptions if field has no value
HAS_REGION()	Determine if REGION has a value

EnablePartialResultsStabilization

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

Accessible with the following methods

Method	Description
GET_ENBPARTIALRSLTSSTABILI00()	Getter for ENBPARTIALRSLTSSTABILIZATION

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.

Accessible with the following methods

Method	Description
GET_PARTIALRESULTSSTABILITY()	Getter for PARTIALRESULTSSTABILITY, with configurable defaul
ASK_PARTIALRESULTSSTABILITY()	Getter for PARTIALRESULTSSTABILITY w/ exceptions if field ha
HAS_PARTIALRESULTSSTABILITY()	Determine if PARTIALRESULTSSTABILITY has a value

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.

Accessible with the following methods

Method	Description
GET_CONTIDENTIFICATIONTYPE()	Getter for CONTENTIDENTIFICATIONTYPE, with configurable defa
ASK_CONTIDENTIFICATIONTYPE()	Getter for CONTENTIDENTIFICATIONTYPE w/ exceptions if field
HAS_CONTIDENTIFICATIONTYPE()	Determine if CONTENTIDENTIFICATIONTYPE has a value

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.

Accessible with the following methods

Method	Description
GET_CONTENTREDACTIONTYPE()	Getter for CONTENTREDACTIONTYPE, with configurable default
ASK_CONTENTREDACTIONTYPE()	Getter for CONTENTREDACTIONTYPE w/ exceptions if field has n
HAS_CONTENTREDACTIONTYPE()	Determine if CONTENTREDACTIONTYPE has a value

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.

Accessible with the following methods

Method	Description
GET_PIIENTITYTYPES()	Getter for PIIENTITYTYPES, with configurable default
ASK_PIIENTITYTYPES()	Getter for PIIENTITYTYPES w/ exceptions if field has no valu
HAS_PIIENTITYTYPES()	Determine if PIIENTITYTYPES has a value

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.

Accessible with the following methods

Method	Description
GET_LANGUAGEMODELNAME()	Getter for LANGUAGEMODELNAME, with configurable default
ASK_LANGUAGEMODELNAME()	Getter for LANGUAGEMODELNAME w/ exceptions if field has no v
HAS_LANGUAGEMODELNAME()	Determine if LANGUAGEMODELNAME has a value

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.

Accessible with the following methods

Method	Description
GET_IDENTIFYLANGUAGE()	Getter for IDENTIFYLANGUAGE

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.

Accessible with the following methods

Method	Description
GET_LANGUAGEOPTIONS()	Getter for LANGUAGEOPTIONS, with configurable default
ASK_LANGUAGEOPTIONS()	Getter for LANGUAGEOPTIONS w/ exceptions if field has no val
HAS_LANGUAGEOPTIONS()	Determine if LANGUAGEOPTIONS has a value

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.

Accessible with the following methods

Method	Description
GET_PREFERREDLANGUAGE()	Getter for PREFERREDLANGUAGE, with configurable default
ASK_PREFERREDLANGUAGE()	Getter for PREFERREDLANGUAGE w/ exceptions if field has no v
HAS_PREFERREDLANGUAGE()	Determine if PREFERREDLANGUAGE has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYNAMES()	Getter for VOCABULARYNAMES, with configurable default
ASK_VOCABULARYNAMES()	Getter for VOCABULARYNAMES w/ exceptions if field has no val
HAS_VOCABULARYNAMES()	Determine if VOCABULARYNAMES has a value

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.

Accessible with the following methods

Method	Description
GET_VOCABULARYFILTERNAMES()	Getter for VOCABULARYFILTERNAMES, with configurable default
ASK_VOCABULARYFILTERNAMES()	Getter for VOCABULARYFILTERNAMES w/ exceptions if field has
HAS_VOCABULARYFILTERNAMES()	Determine if VOCABULARYFILTERNAMES has a value