com.amazonaws.services.transcribe.model

Class TranscriptFilter

java.lang.Object

com.amazonaws.services.transcribe.model.TranscriptFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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

Rules using TranscriptFilter are designed to match:

• Custom words or phrases spoken by the agent, the customer, or both

• Custom words or phrases not spoken by the agent, the customer, or either

• Custom words or phrases that occur at a specific time frame

See Rule criteria for post-call categories and Rule criteria for streaming categories for usage examples.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TranscriptFilter()

Method Summary

Modifier and Type	Method and Description
TranscriptFilter	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 key words or phrases.
Boolean	getNegate() Set to TRUE to flag the absence of the phrase that you specified 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 key words or phrases.
List<String>	getTargets() Specify the phrases that you want to flag.
String	getTranscriptFilterType() Flag the presence or absence of an exact match to the phrases that you specify.
int	hashCode()
Boolean	isNegate() Set to TRUE to flag the absence of the phrase that you specified 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 key words or phrases.
void	setNegate(Boolean negate) Set to TRUE to flag the absence of the phrase that you specified 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 key words or phrases.
void	setTargets(Collection<String> targets) Specify the phrases that you want to flag.
void	setTranscriptFilterType(String transcriptFilterType) Flag the presence or absence of an exact match to the phrases that you specify.
String	toString() Returns a string representation of this object.
TranscriptFilter	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 key words or phrases.
TranscriptFilter	withNegate(Boolean negate) Set to TRUE to flag the absence of the phrase that you specified in your request.
TranscriptFilter	withParticipantRole(ParticipantRole participantRole) Specify the participant that you want to flag.
TranscriptFilter	withParticipantRole(String participantRole) Specify the participant that you want to flag.
TranscriptFilter	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 key words or phrases.
TranscriptFilter	withTargets(Collection<String> targets) Specify the phrases that you want to flag.
TranscriptFilter	withTargets(String... targets) Specify the phrases that you want to flag.
TranscriptFilter	withTranscriptFilterType(String transcriptFilterType) Flag the presence or absence of an exact match to the phrases that you specify.
TranscriptFilter	withTranscriptFilterType(TranscriptFilterType transcriptFilterType) Flag the presence or absence of an exact match to the phrases that you specify.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranscriptFilter

public TranscriptFilter()

Method Detail

setTranscriptFilterType

public void setTranscriptFilterType(String transcriptFilterType)

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Parameters:

transcriptFilterType - Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

See Also:

TranscriptFilterType

getTranscriptFilterType

public String getTranscriptFilterType()

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Returns:

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

See Also:

TranscriptFilterType

withTranscriptFilterType

public TranscriptFilter withTranscriptFilterType(String transcriptFilterType)

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Parameters:

transcriptFilterType - Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Returns:

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

See Also:

TranscriptFilterType

withTranscriptFilterType

public TranscriptFilter withTranscriptFilterType(TranscriptFilterType transcriptFilterType)

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Parameters:

transcriptFilterType - Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Returns:

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

See Also:

TranscriptFilterType

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 key words or phrases. 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 key words or phrases. 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 key words or phrases. 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 key words or phrases. See for more detail.

withAbsoluteTimeRange

public TranscriptFilter 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 key words or phrases. 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 key words or phrases. 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 key words or phrases. 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 key words or phrases. 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 key words or phrases. 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 key words or phrases. See for more detail.

withRelativeTimeRange

public TranscriptFilter 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 key words or phrases. 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 key words or phrases. 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 TranscriptFilter 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 TranscriptFilter 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 absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

Parameters:

negate - Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

getNegate

public Boolean getNegate()

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

Returns:

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

withNegate

public TranscriptFilter withNegate(Boolean negate)

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

Parameters:

negate - Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase 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 absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

Returns:

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

getTargets

public List<String> getTargets()

Specify the phrases that you want to flag.

Returns:

Specify the phrases that you want to flag.

setTargets

public void setTargets(Collection<String> targets)

Specify the phrases that you want to flag.

Parameters:

targets - Specify the phrases that you want to flag.

withTargets

public TranscriptFilter withTargets(String... targets)

Specify the phrases that you want to flag.

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

Parameters:

targets - Specify the phrases that you want to flag.

Returns:

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

withTargets

public TranscriptFilter withTargets(Collection<String> targets)

Specify the phrases that you want to flag.

Parameters:

targets - Specify the phrases that you want to flag.

Returns:

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

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 TranscriptFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo