software.amazon.awssdk.services.transcribe.model

Class TranscriptFilter

java.lang.Object

software.amazon.awssdk.services.transcribe.model.TranscriptFilter

All Implemented Interfaces:

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

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

Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TranscriptFilter.Builder

Method Summary

Modifier and Type	Method and Description
AbsoluteTimeRange	absoluteTimeRange() A time range, set in seconds, between two points in the call.
static TranscriptFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
Boolean	negate() If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
ParticipantRole	participantRole() Determines whether the customer or the agent is speaking the phrases that you've specified.
String	participantRoleAsString() Determines whether the customer or the agent is speaking the phrases that you've specified.
RelativeTimeRange	relativeTimeRange() An object that allows percentages to specify the proportion of the call where you would like to apply a filter.
List<SdkField<?>>	sdkFields()
static Class<? extends TranscriptFilter.Builder>	serializableBuilderClass()
List<String>	targets() The phrases that you're specifying for the transcript filter to match.
TranscriptFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TranscriptFilterType	transcriptFilterType() Matches the phrase to the transcription output in a word for word fashion.
String	transcriptFilterTypeAsString() Matches the phrase to the transcription output in a word for word fashion.

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

transcriptFilterType

public final TranscriptFilterType transcriptFilterType()

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

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

Returns:

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

See Also:

TranscriptFilterType

transcriptFilterTypeAsString

public final String transcriptFilterTypeAsString()

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

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

Returns:

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

See Also:

TranscriptFilterType

absoluteTimeRange

public final AbsoluteTimeRange absoluteTimeRange()

A time range, set in seconds, between two points in the call.

Returns:

A time range, set in seconds, between two points in the call.

relativeTimeRange

public final RelativeTimeRange relativeTimeRange()

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.

Returns:

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.

participantRole

public final ParticipantRole participantRole()

Determines whether the customer or the agent is speaking the phrases that you've specified.

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

Returns:

Determines whether the customer or the agent is speaking the phrases that you've specified.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Determines whether the customer or the agent is speaking the phrases that you've specified.

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

Returns:

Determines whether the customer or the agent is speaking the phrases that you've specified.

See Also:

ParticipantRole

negate

public final Boolean negate()

If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.

Returns:

If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets 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.

targets

public final List<String> targets()

The phrases that you're specifying for the transcript filter to match.

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 hasTargets() method.

Returns:

The phrases that you're specifying for the transcript filter to match.

toBuilder

public TranscriptFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TranscriptFilter.Builder,TranscriptFilter>

builder

public static TranscriptFilter.Builder builder()

serializableBuilderClass

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