Class: Aws::VoiceID::Types::AuthenticationResult

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

Overview

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

See Also:

Constant Summary collapse

SENSITIVE = 
[:customer_speaker_id]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_aggregation_ended_at ⇒ Time

A timestamp of when audio aggregation ended for this authentication result.

Returns:

  • (Time) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#audio_aggregation_started_at ⇒ Time

A timestamp of when audio aggregation started for this authentication result.

Returns:

  • (Time) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#authentication_result_id ⇒ String

The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, ‘AcceptanceThreshold` changes, or `SpeakerId` changes, Voice ID always returns cached Authentication Result for this API.

Returns:

  • (String) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#configuration ⇒ Types::AuthenticationConfiguration

The ‘AuthenticationConfiguration` used to generate this authentication result.

Returns:



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#customer_speaker_id ⇒ String

The client-provided identifier for the speaker whose authentication result is produced. Only present if a ‘SpeakerId` is provided for the session.

Returns:

  • (String) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#decision ⇒ String

The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

Returns:

  • (String) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#generated_speaker_id ⇒ String

The service-generated identifier for the speaker whose authentication result is produced.

Returns:

  • (String) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end

#score ⇒ Integer

The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ‘ACCEPT` or `REJECT`.

Returns:

  • (Integer) 


128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aws-sdk-voiceid/types.rb', line 128

class AuthenticationResult < Struct.new(
  :audio_aggregation_ended_at,
  :audio_aggregation_started_at,
  :authentication_result_id,
  :configuration,
  :customer_speaker_id,
  :decision,
  :generated_speaker_id,
  :score)
  SENSITIVE = [:customer_speaker_id]
  include Aws::Structure
end