software.amazon.awssdk.services.chimesdkmediapipelines.model

Class AmazonTranscribeCallAnalyticsProcessorConfiguration

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.AmazonTranscribeCallAnalyticsProcessorConfiguration

All Implemented Interfaces:

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

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

A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder	builder()
List<String>	callAnalyticsStreamCategories() By default, all CategoryEvents are sent to the insights target.
ContentType	contentIdentificationType() Labels all personally identifiable information (PII) identified in your transcript.
String	contentIdentificationTypeAsString() Labels all personally identifiable information (PII) identified in your transcript.
ContentType	contentRedactionType() Redacts all personally identifiable information (PII) identified in your transcript.
String	contentRedactionTypeAsString() Redacts all personally identifiable information (PII) identified in your transcript.
Boolean	enablePartialResultsStabilization() Enables partial result stabilization for your transcription.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	filterPartialResults() If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCallAnalyticsStreamCategories() For responses, this returns true if the service returned a value for the CallAnalyticsStreamCategories property.
int	hashCode()
CallAnalyticsLanguageCode	languageCode() The language code in the configuration.
String	languageCodeAsString() The language code in the configuration.
String	languageModelName() Specifies the name of the custom language model to use when processing a transcription.
PartialResultsStability	partialResultsStability() Specifies the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).
String	partialResultsStabilityAsString() Specifies the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).
String	piiEntityTypes() Specifies the types of personally identifiable information (PII) to redact from a transcript.
PostCallAnalyticsSettings	postCallAnalyticsSettings() The settings for a post-call analysis task in an analytics configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder>	serializableBuilderClass()
AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VocabularyFilterMethod	vocabularyFilterMethod() Specifies how to apply a vocabulary filter to a transcript.
String	vocabularyFilterMethodAsString() Specifies how to apply a vocabulary filter to a transcript.
String	vocabularyFilterName() Specifies the name of the custom vocabulary filter to use when processing a transcription.
String	vocabularyName() Specifies the name of the custom vocabulary to use when processing a transcription.

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 CallAnalyticsLanguageCode languageCode()

The language code in the configuration.

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

Returns:

The language code in the configuration.

See Also:

CallAnalyticsLanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code in the configuration.

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

Returns:

The language code in the configuration.

See Also:

CallAnalyticsLanguageCode

vocabularyName

public final String vocabularyName()

Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive.

If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.

For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

Returns:

Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive.

If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.

For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

vocabularyFilterName

public final String vocabularyFilterName()

Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive.

If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.

For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

Returns:

Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive.

If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.

For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

vocabularyFilterMethod

public final VocabularyFilterMethod vocabularyFilterMethod()

Specifies how to apply a vocabulary filter to a transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

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

Returns:

Specifies how to apply a vocabulary filter to a transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

See Also:

VocabularyFilterMethod

vocabularyFilterMethodAsString

public final String vocabularyFilterMethodAsString()

Specifies how to apply a vocabulary filter to a transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

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

Returns:

Specifies how to apply a vocabulary filter to a transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

See Also:

VocabularyFilterMethod

languageModelName

public final String languageModelName()

Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

Returns:

Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

enablePartialResultsStabilization

public final Boolean enablePartialResultsStabilization()

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

Returns:

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

partialResultsStability

public final PartialResultsStability partialResultsStability()

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

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

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

Returns:

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

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

See Also:

PartialResultsStability

partialResultsStabilityAsString

public final String partialResultsStabilityAsString()

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

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

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

Returns:

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

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

See Also:

PartialResultsStability

contentIdentificationType

public final ContentType contentIdentificationType()

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

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

Returns:

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

See Also:

ContentType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

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

Returns:

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

See Also:

ContentType

contentRedactionType

public final ContentType contentRedactionType()

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

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

Returns:

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

See Also:

ContentType

contentRedactionTypeAsString

public final String contentRedactionTypeAsString()

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

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

Returns:

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

See Also:

ContentType

piiEntityTypes

public final String piiEntityTypes()

Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

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.

Length Constraints: Minimum length of 1. Maximum length of 300.

Returns:

Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

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.

Length Constraints: Minimum length of 1. Maximum length of 300.

filterPartialResults

public final Boolean filterPartialResults()

If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.

Returns:

If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.

postCallAnalyticsSettings

public final PostCallAnalyticsSettings postCallAnalyticsSettings()

The settings for a post-call analysis task in an analytics configuration.

Returns:

The settings for a post-call analysis task in an analytics configuration.

hasCallAnalyticsStreamCategories

public final boolean hasCallAnalyticsStreamCategories()

For responses, this returns true if the service returned a value for the CallAnalyticsStreamCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

callAnalyticsStreamCategories

public final List<String> callAnalyticsStreamCategories()

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCallAnalyticsStreamCategories() method.

Returns:

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

toBuilder

public AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder,AmazonTranscribeCallAnalyticsProcessorConfiguration>

builder

public static AmazonTranscribeCallAnalyticsProcessorConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AmazonTranscribeCallAnalyticsProcessorConfiguration.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