software.amazon.awssdk.services.voiceid.model

Interface FraudDetectionResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FraudDetectionResult.Builder,FraudDetectionResult>, SdkBuilder<FraudDetectionResult.Builder,FraudDetectionResult>, SdkPojo

Enclosing class:

FraudDetectionResult

public static interface FraudDetectionResult.Builder
extends SdkPojo, CopyableBuilder<FraudDetectionResult.Builder,FraudDetectionResult>

Method Summary

Modifier and Type	Method and Description
FraudDetectionResult.Builder	audioAggregationEndedAt(Instant audioAggregationEndedAt) A timestamp indicating when audio aggregation ended for this fraud detection result.
FraudDetectionResult.Builder	audioAggregationStartedAt(Instant audioAggregationStartedAt) A timestamp indicating when audio aggregation started for this fraud detection result.
default FraudDetectionResult.Builder	configuration(Consumer<FraudDetectionConfiguration.Builder> configuration) The FraudDetectionConfiguration used to generate this fraud detection result.
FraudDetectionResult.Builder	configuration(FraudDetectionConfiguration configuration) The FraudDetectionConfiguration used to generate this fraud detection result.
FraudDetectionResult.Builder	decision(FraudDetectionDecision decision) The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
FraudDetectionResult.Builder	decision(String decision) The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
FraudDetectionResult.Builder	fraudDetectionResultId(String fraudDetectionResultId) The unique identifier for this fraud detection result.
FraudDetectionResult.Builder	reasons(Collection<FraudDetectionReason> reasons) The reason speaker was flagged by the fraud detection system.
FraudDetectionResult.Builder	reasons(FraudDetectionReason... reasons) The reason speaker was flagged by the fraud detection system.
FraudDetectionResult.Builder	reasonsWithStrings(Collection<String> reasons) The reason speaker was flagged by the fraud detection system.
FraudDetectionResult.Builder	reasonsWithStrings(String... reasons) The reason speaker was flagged by the fraud detection system.
default FraudDetectionResult.Builder	riskDetails(Consumer<FraudRiskDetails.Builder> riskDetails) Details about each risk analyzed for this speaker.
FraudDetectionResult.Builder	riskDetails(FraudRiskDetails riskDetails) Details about each risk analyzed for this speaker.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

audioAggregationEndedAt

FraudDetectionResult.Builder audioAggregationEndedAt(Instant audioAggregationEndedAt)

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

Parameters:

audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this fraud detection result.

Returns:

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

audioAggregationStartedAt

FraudDetectionResult.Builder audioAggregationStartedAt(Instant audioAggregationStartedAt)

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

Parameters:

audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this fraud detection result.

Returns:

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

configuration

FraudDetectionResult.Builder configuration(FraudDetectionConfiguration configuration)

The FraudDetectionConfiguration used to generate this fraud detection result.

Parameters:

configuration - The FraudDetectionConfiguration used to generate this fraud detection result.

Returns:

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

configuration

default FraudDetectionResult.Builder configuration(Consumer<FraudDetectionConfiguration.Builder> configuration)

The FraudDetectionConfiguration used to generate this fraud detection result.

This is a convenience method that creates an instance of the FraudDetectionConfiguration.Builder avoiding the need to create one manually via FraudDetectionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(FraudDetectionConfiguration).

Parameters:

configuration - a consumer that will call methods on FraudDetectionConfiguration.Builder

Returns:

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

See Also:

configuration(FraudDetectionConfiguration)

decision

FraudDetectionResult.Builder decision(String decision)

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

Parameters:

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

Returns:

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

See Also:

FraudDetectionDecision, FraudDetectionDecision

decision

FraudDetectionResult.Builder decision(FraudDetectionDecision decision)

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

Parameters:

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

Returns:

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

See Also:

FraudDetectionDecision, FraudDetectionDecision

fraudDetectionResultId

FraudDetectionResult.Builder fraudDetectionResultId(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.

Parameters:

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:

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

reasonsWithStrings

FraudDetectionResult.Builder reasonsWithStrings(Collection<String> 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.

Parameters:

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.

Returns:

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

reasonsWithStrings

FraudDetectionResult.Builder reasonsWithStrings(String... 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.

Parameters:

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.

Returns:

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

reasons

FraudDetectionResult.Builder reasons(Collection<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.

Parameters:

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.

Returns:

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

reasons

FraudDetectionResult.Builder reasons(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.

Parameters:

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.

Returns:

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

riskDetails

FraudDetectionResult.Builder riskDetails(FraudRiskDetails riskDetails)

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

Parameters:

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

Returns:

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

riskDetails

default FraudDetectionResult.Builder riskDetails(Consumer<FraudRiskDetails.Builder> riskDetails)

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

This is a convenience method that creates an instance of the FraudRiskDetails.Builder avoiding the need to create one manually via FraudRiskDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to riskDetails(FraudRiskDetails).

Parameters:

riskDetails - a consumer that will call methods on FraudRiskDetails.Builder

Returns:

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

See Also:

riskDetails(FraudRiskDetails)