@Generated(value="software.amazon.awssdk:codegen") public final class EvaluateSessionResponse extends VoiceIdResponse implements ToCopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
EvaluateSessionResponse.Builder |
| Modifier and Type | Method and 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.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final AuthenticationResult authenticationResult()
Details resulting from the authentication process, such as authentication decision and authentication score.
public final String domainId()
The identifier of the domain that contains the session.
public final FraudDetectionResult fraudDetectionResult()
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
public final String sessionId()
The service-generated identifier of the session.
public final String sessionName()
The client-provided name of the session.
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().
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.StreamingStatuspublic 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().
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.StreamingStatuspublic EvaluateSessionResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>toBuilder in class AwsResponsepublic static EvaluateSessionResponse.Builder builder()
public static Class<? extends EvaluateSessionResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.