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

Interface EvaluateSessionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>, SdkBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>, SdkPojo, SdkResponse.Builder, VoiceIdResponse.Builder
Enclosing class:
EvaluateSessionResponse
public static interface EvaluateSessionResponse.Builder extends VoiceIdResponse.Builder, SdkPojo, CopyableBuilder<EvaluateSessionResponse.Builder,EvaluateSessionResponse>

  • Method Details

    • authenticationResult

      EvaluateSessionResponse.Builder authenticationResult(AuthenticationResult authenticationResult)

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

      Parameters:
      authenticationResult - Details resulting from the authentication process, such as authentication decision and authentication score.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationResult

      default EvaluateSessionResponse.Builder authenticationResult(Consumer<AuthenticationResult.Builder> authenticationResult)

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

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

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

      Parameters:
      authenticationResult - a consumer that will call methods on AuthenticationResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainId

      EvaluateSessionResponse.Builder domainId(String domainId)

      The identifier of the domain that contains the session.

      Parameters:
      domainId - The identifier of the domain that contains the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fraudDetectionResult

      EvaluateSessionResponse.Builder fraudDetectionResult(FraudDetectionResult fraudDetectionResult)

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

      Parameters:
      fraudDetectionResult - Details resulting from the fraud detection process, such as fraud detection decision and risk score.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fraudDetectionResult

      default EvaluateSessionResponse.Builder fraudDetectionResult(Consumer<FraudDetectionResult.Builder> fraudDetectionResult)

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

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

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

      Parameters:
      fraudDetectionResult - a consumer that will call methods on FraudDetectionResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sessionId

      EvaluateSessionResponse.Builder sessionId(String sessionId)

      The service-generated identifier of the session.

      Parameters:
      sessionId - The service-generated identifier of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionName

      EvaluateSessionResponse.Builder sessionName(String sessionName)

      The client-provided name of the session.

      Parameters:
      sessionName - The client-provided name of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamingStatus

      EvaluateSessionResponse.Builder streamingStatus(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamingStatus

      EvaluateSessionResponse.Builder streamingStatus(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: