Class: Aws::VoiceID::Types::EvaluateSessionResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_resultTypes::AuthenticationResult

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



613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end

#domain_idString

The identifier of the domain containing the session.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end

#fraud_detection_resultTypes::FraudDetectionResult

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



613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

The service-generated identifier of the session.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end

#session_nameString

The client-provided name of the session.

Returns:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end

#streaming_statusString

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:

  • (String)


613
614
615
616
617
618
619
620
621
622
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 613

class EvaluateSessionResponse < Struct.new(
  :authentication_result,
  :domain_id,
  :fraud_detection_result,
  :session_id,
  :session_name,
  :streaming_status)
  SENSITIVE = []
  include Aws::Structure
end