Package software.amazon.awssdk.services.voiceid.model

Class FraudDetectionResult

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

The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

See Also:

  • Method Details

    • audioAggregationEndedAt

      public final Instant audioAggregationEndedAt()

      A timestamp of when audio aggregation ended for this fraud detection result.

      Returns:
      A timestamp of when audio aggregation ended for this fraud detection result.

    • audioAggregationStartedAt

      public final Instant audioAggregationStartedAt()

      A timestamp of when audio aggregation started for this fraud detection result.

      Returns:
      A timestamp of when audio aggregation started for this fraud detection result.

    • configuration

      public final FraudDetectionConfiguration configuration()

      The FraudDetectionConfiguration used to generate this fraud detection result.

      Returns:
      The FraudDetectionConfiguration used to generate this fraud detection result.

    • decision

      public final FraudDetectionDecision decision()

      The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

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

      Returns:
      The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
      See Also:

    • decisionAsString

      public final String decisionAsString()

      The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

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

      Returns:
      The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
      See Also:

    • fraudDetectionResultId

      public final String fraudDetectionResultId()

      The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

      Returns:
      The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

    • reasons

      public final List<FraudDetectionReason> reasons()

      The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

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

      Returns:
      The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

    • hasReasons

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

    • reasonsAsStrings

      public final List<String> reasonsAsStrings()

      The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

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

      Returns:
      The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

    • riskDetails

      public final FraudRiskDetails riskDetails()

      Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.

      Returns:
      Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.

    • toBuilder

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

    • builder

      public static FraudDetectionResult.Builder builder()

    • serializableBuilderClass

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