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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_result ⇒ Types::AuthenticationResult

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

Returns:



802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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

#domain_id ⇒ String

The identifier of the domain that contains the session.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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

#fraud_detection_result ⇒ Types::FraudDetectionResult

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

Returns:



802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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

#session_id ⇒ String

The service-generated identifier of the session.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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

#session_name ⇒ String

The client-provided name of the session.

Returns:

  • (String) 


802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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

#streaming_status ⇒ String

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) 


802
803
804
805
806
807
808
809
810
811
 
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb', line 802

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