Package software.amazon.awssdk.services.transcribe.model

Class TranscriptFilter

java.lang.Object
software.amazon.awssdk.services.transcribe.model.TranscriptFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TranscriptFilter.Builder,TranscriptFilter>
@Generated("software.amazon.awssdk:codegen") public final class TranscriptFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptFilter.Builder,TranscriptFilter>

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:

  • Method Details

    • transcriptFilterType

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

      If the service returns an enum value that is not available in the current SDK version, transcriptFilterType will return TranscriptFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptFilterTypeAsString().

      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:

    • transcriptFilterTypeAsString

      public final String transcriptFilterTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, transcriptFilterType will return TranscriptFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptFilterTypeAsString().

      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:

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

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

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

    • hasTargets

      public final boolean hasTargets()
      For responses, this returns true if the service returned a value for the Targets 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.

    • targets

      public final List<String> targets()

      Specify the phrases 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 hasTargets() method.

      Returns:
      Specify the phrases that you want to flag.

    • toBuilder

      public TranscriptFilter.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<TranscriptFilter.Builder,TranscriptFilter>
      Returns:
      a builder for type T

    • builder

      public static TranscriptFilter.Builder builder()

    • serializableBuilderClass

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