@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 batch categories for usage examples.
| Modifier and Type | Class and Description |
|---|---|
static interface |
SentimentFilter.Builder |
| Modifier and Type | Method and Description |
|---|---|
AbsoluteTimeRange |
absoluteTimeRange()
Makes it possible 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 that you didn't include in your request. |
ParticipantRole |
participantRole()
Specify the participant that you want to flag.
|
String |
participantRoleAsString()
Specify the participant that you want to flag.
|
RelativeTimeRange |
relativeTimeRange()
Makes it possible 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 that you want to flag.
|
List<String> |
sentimentsAsStrings()
Specify the sentiments that you want to flag.
|
static Class<? extends SentimentFilter.Builder> |
serializableBuilderClass() |
SentimentFilter.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final List<SentimentValue> sentiments()
Specify the sentiments that 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.
public final boolean hasSentiments()
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.public final List<String> sentimentsAsStrings()
Specify the sentiments that 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.
public final AbsoluteTimeRange absoluteTimeRange()
Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.
public final RelativeTimeRange relativeTimeRange()
Makes it possible 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.
public final ParticipantRole participantRole()
Specify the participant that 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().
ParticipantRolepublic final String participantRoleAsString()
Specify the participant that 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().
ParticipantRolepublic final Boolean negate()
Set to TRUE to flag the sentiments that you didn't include in your request. Set to
FALSE to flag the sentiments that you specified in your request.
TRUE to flag the sentiments that you didn't include in your request. Set to
FALSE to flag the sentiments that you specified in your request.public SentimentFilter.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SentimentFilter.Builder,SentimentFilter>public static SentimentFilter.Builder builder()
public static Class<? extends SentimentFilter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.