software.amazon.awssdk.services.chime.model

Class EngineTranscribeSettings

java.lang.Object

software.amazon.awssdk.services.chime.model.EngineTranscribeSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class EngineTranscribeSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>

Settings specific to the Amazon Transcribe engine.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EngineTranscribeSettings.Builder

Method Summary

Modifier and Type	Method and Description
static EngineTranscribeSettings.Builder	builder()
TranscribeContentIdentificationType	contentIdentificationType() Set this field to PII to identify personally identifiable information in the transcription output.
String	contentIdentificationTypeAsString() Set this field to PII to identify personally identifiable information in the transcription output.
TranscribeContentRedactionType	contentRedactionType() Set this field to PII to redact personally identifiable information in the transcription output.
String	contentRedactionTypeAsString() Set this field to PII to redact personally identifiable information in the transcription output.
Boolean	enablePartialResultsStabilization() Generates partial transcription results that are less likely to change as meeting attendees speak.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
TranscribeLanguageCode	languageCode() The language code specified for the Amazon Transcribe engine.
String	languageCodeAsString() The language code specified for the Amazon Transcribe engine.
String	languageModelName() The name of the language model used during transcription.
TranscribePartialResultsStability	partialResultsStability() The stabity level of a partial results transcription.
String	partialResultsStabilityAsString() The stabity level of a partial results transcription.
String	piiEntityTypes() Lists the PII entity types you want to identify or redact.
TranscribeRegion	region() The AWS Region passed to Amazon Transcribe.
String	regionAsString() The AWS Region passed to Amazon Transcribe.
List<SdkField<?>>	sdkFields()
static Class<? extends EngineTranscribeSettings.Builder>	serializableBuilderClass()
EngineTranscribeSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TranscribeVocabularyFilterMethod	vocabularyFilterMethod() The filtering method passed to Amazon Transcribe.
String	vocabularyFilterMethodAsString() The filtering method passed to Amazon Transcribe.
String	vocabularyFilterName() The name of the vocabulary filter passed to Amazon Transcribe.
String	vocabularyName() The name of the vocabulary passed to Amazon Transcribe.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

languageCode

public final TranscribeLanguageCode languageCode()

The language code specified for the Amazon Transcribe engine.

If the service returns an enum value that is not available in the current SDK version, languageCode will return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code specified for the Amazon Transcribe engine.

See Also:

TranscribeLanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code specified for the Amazon Transcribe engine.

If the service returns an enum value that is not available in the current SDK version, languageCode will return TranscribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code specified for the Amazon Transcribe engine.

See Also:

TranscribeLanguageCode

vocabularyFilterMethod

public final TranscribeVocabularyFilterMethod vocabularyFilterMethod()

The filtering method passed to Amazon Transcribe.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return TranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

The filtering method passed to Amazon Transcribe.

See Also:

TranscribeVocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

The filtering method passed to Amazon Transcribe.

If the service returns an enum value that is not available in the current SDK version, vocabularyFilterMethod will return TranscribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vocabularyFilterMethodAsString().

Returns:

The filtering method passed to Amazon Transcribe.

See Also:

TranscribeVocabularyFilterMethod

vocabularyFilterName

public final String vocabularyFilterName()

The name of the vocabulary filter passed to Amazon Transcribe.

Returns:

The name of the vocabulary filter passed to Amazon Transcribe.

vocabularyName

public final String vocabularyName()

The name of the vocabulary passed to Amazon Transcribe.

Returns:

The name of the vocabulary passed to Amazon Transcribe.

region

public final TranscribeRegion region()

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

If the service returns an enum value that is not available in the current SDK version, region will return TranscribeRegion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from regionAsString().

Returns:

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

See Also:

TranscribeRegion

regionAsString

public final String regionAsString()

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

If the service returns an enum value that is not available in the current SDK version, region will return TranscribeRegion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from regionAsString().

Returns:

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

See Also:

TranscribeRegion

enablePartialResultsStabilization

public final Boolean enablePartialResultsStabilization()

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

Returns:

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

partialResultsStability

public final TranscribePartialResultsStability partialResultsStability()

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

If the service returns an enum value that is not available in the current SDK version, partialResultsStability will return TranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partialResultsStabilityAsString().

Returns:

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

See Also:

TranscribePartialResultsStability

partialResultsStabilityAsString

public final String partialResultsStabilityAsString()

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

If the service returns an enum value that is not available in the current SDK version, partialResultsStability will return TranscribePartialResultsStability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partialResultsStabilityAsString().

Returns:

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

See Also:

TranscribePartialResultsStability

contentIdentificationType

public final TranscribeContentIdentificationType contentIdentificationType()

Set this field to PII to identify personally identifiable information in the transcription output.

If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return TranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from contentIdentificationTypeAsString().

Returns:

Set this field to PII to identify personally identifiable information in the transcription output.

See Also:

TranscribeContentIdentificationType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Set this field to PII to identify personally identifiable information in the transcription output.

If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return TranscribeContentIdentificationType.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from contentIdentificationTypeAsString().

Returns:

Set this field to PII to identify personally identifiable information in the transcription output.

See Also:

TranscribeContentIdentificationType

contentRedactionType

public final TranscribeContentRedactionType contentRedactionType()

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

If the service returns an enum value that is not available in the current SDK version, contentRedactionType will return TranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionTypeAsString().

Returns:

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

See Also:

TranscribeContentRedactionType

contentRedactionTypeAsString

public final String contentRedactionTypeAsString()

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

If the service returns an enum value that is not available in the current SDK version, contentRedactionType will return TranscribeContentRedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionTypeAsString().

Returns:

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

See Also:

TranscribeContentRedactionType

piiEntityTypes

public final String piiEntityTypes()

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

Returns:

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

languageModelName

public final String languageModelName()

The name of the language model used during transcription.

Returns:

The name of the language model used during transcription.

toBuilder

public EngineTranscribeSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EngineTranscribeSettings.Builder,EngineTranscribeSettings>

builder

public static EngineTranscribeSettings.Builder builder()

serializableBuilderClass

public static Class<? extends EngineTranscribeSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo