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

See Also:

  • Method Details

    • sentiments

      public 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.

      Returns:
      Specify the sentiments that 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 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.

      Returns:
      Specify the sentiments that you want to flag.

    • absoluteTimeRange

      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.

      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.

    • relativeTimeRange

      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.

      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.

    • participantRole

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

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

    • participantRoleAsString

      public 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().

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

    • negate

      public 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.

      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.

    • toBuilder

      public SentimentFilter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SentimentFilter.Builder,SentimentFilter>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.