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

Class EvaluateSessionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.voiceid.model.VoiceIdResponse

software.amazon.awssdk.services.voiceid.model.EvaluateSessionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>

@Generated("software.amazon.awssdk:codegen")
public final class EvaluateSessionResponse
extends VoiceIdResponse
implements ToCopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EvaluateSessionResponse.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationResult	authenticationResult()	Details resulting from the authentication process, such as authentication decision and authentication score.
static EvaluateSessionResponse.Builder	builder()
String	domainId()	The identifier of the domain that contains the session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FraudDetectionResult	fraudDetectionResult()	Details resulting from the fraud detection process, such as fraud detection decision and risk score.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluateSessionResponse.Builder>	serializableBuilderClass()
String	sessionId()	The service-generated identifier of the session.
String	sessionName()	The client-provided name of the session.
StreamingStatus	streamingStatus()	The current status of audio streaming for this session.
String	streamingStatusAsString()	The current status of audio streaming for this session.
EvaluateSessionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.voiceid.model.VoiceIdResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

authenticationResult

public final AuthenticationResult authenticationResult()

Details resulting from the authentication process, such as authentication decision and authentication score.

Returns:

Details resulting from the authentication process, such as authentication decision and authentication score.

domainId

public final String domainId()

The identifier of the domain that contains the session.

Returns:

The identifier of the domain that contains the session.

fraudDetectionResult

public final FraudDetectionResult fraudDetectionResult()

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

Returns:

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

sessionId

public final String sessionId()

The service-generated identifier of the session.

Returns:

The service-generated identifier of the session.

sessionName

public final String sessionName()

The client-provided name of the session.

Returns:

The client-provided name of the session.

streamingStatus

public final StreamingStatus streamingStatus()

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

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

Returns:

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

See Also:

StreamingStatus

streamingStatusAsString

public final String streamingStatusAsString()

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

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

Returns:

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

See Also:

StreamingStatus

toBuilder

public EvaluateSessionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static EvaluateSessionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends EvaluateSessionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo