software.amazon.awssdk.services.transcribe.model

Class SentimentFilter

java.lang.Object

software.amazon.awssdk.services.transcribe.model.SentimentFilter

All Implemented Interfaces:

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

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

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

• The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call

• The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call

• The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call

• The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for examples.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SentimentFilter.Builder

Method Summary

Modifier and Type	Method and Description
AbsoluteTimeRange	absoluteTimeRange() Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments.
static SentimentFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSentiments() For responses, this returns true if the service returned a value for the Sentiments property.
Boolean	negate() Set to TRUE to flag the sentiments you didn't include in your request.
ParticipantRole	participantRole() Specify the participant you want to flag.
String	participantRoleAsString() Specify the participant you want to flag.
RelativeTimeRange	relativeTimeRange() Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments.
List<SdkField<?>>	sdkFields()
List<SentimentValue>	sentiments() Specify the sentiments you want to flag.
List<String>	sentimentsAsStrings() Specify the sentiments you want to flag.
static Class<? extends SentimentFilter.Builder>	serializableBuilderClass()
SentimentFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

sentiments

public final List<SentimentValue> sentiments()

Specify the sentiments you want to flag.

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

Returns:

Specify the sentiments you want to flag.

hasSentiments

public final boolean hasSentiments()

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

sentimentsAsStrings

public final List<String> sentimentsAsStrings()

Specify the sentiments you want to flag.

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

Returns:

Specify the sentiments you want to flag.

absoluteTimeRange

public final AbsoluteTimeRange absoluteTimeRange()

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

Returns:

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

relativeTimeRange

public final RelativeTimeRange relativeTimeRange()

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

Returns:

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

participantRole

public final ParticipantRole participantRole()

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

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:

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

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:

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

See Also:

ParticipantRole

negate

public final Boolean negate()

Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

Returns:

Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

toBuilder

public SentimentFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SentimentFilter.Builder,SentimentFilter>

builder

public static SentimentFilter.Builder builder()

serializableBuilderClass

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