com.amazonaws.services.transcribe.model

Class SentimentFilter

java.lang.Object

com.amazonaws.services.transcribe.model.SentimentFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SentimentFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

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 post-call categories for usage examples.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SentimentFilter()

Method Summary

Modifier and Type	Method and Description
SentimentFilter	clone()
boolean	equals(Object obj)
AbsoluteTimeRange	getAbsoluteTimeRange() Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments.
Boolean	getNegate() Set to TRUE to flag the sentiments that you didn't include in your request.
String	getParticipantRole() Specify the participant that you want to flag.
RelativeTimeRange	getRelativeTimeRange() 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<String>	getSentiments() Specify the sentiments that you want to flag.
int	hashCode()
Boolean	isNegate() Set to TRUE to flag the sentiments that you didn't include in your request.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAbsoluteTimeRange(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.
void	setNegate(Boolean negate) Set to TRUE to flag the sentiments that you didn't include in your request.
void	setParticipantRole(String participantRole) Specify the participant that you want to flag.
void	setRelativeTimeRange(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.
void	setSentiments(Collection<String> sentiments) Specify the sentiments that you want to flag.
String	toString() Returns a string representation of this object.
SentimentFilter	withAbsoluteTimeRange(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.
SentimentFilter	withNegate(Boolean negate) Set to TRUE to flag the sentiments that you didn't include in your request.
SentimentFilter	withParticipantRole(ParticipantRole participantRole) Specify the participant that you want to flag.
SentimentFilter	withParticipantRole(String participantRole) Specify the participant that you want to flag.
SentimentFilter	withRelativeTimeRange(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.
SentimentFilter	withSentiments(Collection<String> sentiments) Specify the sentiments that you want to flag.
SentimentFilter	withSentiments(SentimentValue... sentiments) Specify the sentiments that you want to flag.
SentimentFilter	withSentiments(String... sentiments) Specify the sentiments that you want to flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

SentimentFilter

public SentimentFilter()

Method Detail

getSentiments

public List<String> getSentiments()

Specify the sentiments that you want to flag.

Returns:

Specify the sentiments that you want to flag.

See Also:

SentimentValue

setSentiments

public void setSentiments(Collection<String> sentiments)

Specify the sentiments that you want to flag.

Parameters:

sentiments - Specify the sentiments that you want to flag.

See Also:

SentimentValue

withSentiments

public SentimentFilter withSentiments(String... sentiments)

Specify the sentiments that you want to flag.

NOTE: This method appends the values to the existing list (if any). Use setSentiments(java.util.Collection) or withSentiments(java.util.Collection) if you want to override the existing values.

Parameters:

sentiments - Specify the sentiments that you want to flag.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SentimentValue

withSentiments

public SentimentFilter withSentiments(Collection<String> sentiments)

Specify the sentiments that you want to flag.

Parameters:

sentiments - Specify the sentiments that you want to flag.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SentimentValue

withSentiments

public SentimentFilter withSentiments(SentimentValue... sentiments)

Specify the sentiments that you want to flag.

Parameters:

sentiments - Specify the sentiments that you want to flag.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SentimentValue

setAbsoluteTimeRange

public void setAbsoluteTimeRange(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.

Parameters:

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.

getAbsoluteTimeRange

public AbsoluteTimeRange getAbsoluteTimeRange()

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.

Returns:

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.

withAbsoluteTimeRange

public SentimentFilter withAbsoluteTimeRange(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRelativeTimeRange

public void setRelativeTimeRange(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.

Parameters:

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.

getRelativeTimeRange

public RelativeTimeRange getRelativeTimeRange()

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.

Returns:

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.

withRelativeTimeRange

public SentimentFilter withRelativeTimeRange(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setParticipantRole

public void setParticipantRole(String participantRole)

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

Parameters:

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

See Also:

ParticipantRole

getParticipantRole

public String getParticipantRole()

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

Returns:

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

See Also:

ParticipantRole

withParticipantRole

public SentimentFilter withParticipantRole(String participantRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantRole

withParticipantRole

public SentimentFilter withParticipantRole(ParticipantRole participantRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantRole

setNegate

public void setNegate(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.

Parameters:

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.

getNegate

public Boolean getNegate()

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.

Returns:

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.

withNegate

public SentimentFilter withNegate(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isNegate

public Boolean isNegate()

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.

Returns:

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SentimentFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo