AuthenticationResult
The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Contents
- AudioAggregationEndedAt
-
A timestamp of when audio aggregation ended for this authentication result.
Type: Timestamp
Required: No
- AudioAggregationStartedAt
-
A timestamp of when audio aggregation started for this authentication result.
Type: Timestamp
Required: No
- AuthenticationResultId
-
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,
AcceptanceThresholdchanges, orSpeakerIdchanges, Voice ID always returns cached Authentication Result for this API.Type: String
Length Constraints: Fixed length of 22.
Pattern:
^[a-zA-Z0-9]{22}$Required: No
- Configuration
-
The
AuthenticationConfigurationused to generate this authentication result.Type: AuthenticationConfiguration object
Required: No
- CustomerSpeakerId
-
The client-provided identifier for the speaker whose authentication result is produced. Only present if a
SpeakerIdis provided for the session.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_-]*$Required: No
- Decision
-
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Type: String
Valid Values:
ACCEPT | REJECT | NOT_ENOUGH_SPEECH | SPEAKER_NOT_ENROLLED | SPEAKER_OPTED_OUT | SPEAKER_ID_NOT_PROVIDED | SPEAKER_EXPIREDRequired: No
- GeneratedSpeakerId
-
The service-generated identifier for the speaker whose authentication result is produced.
Type: String
Length Constraints: Fixed length of 25.
Pattern:
^id#[a-zA-Z0-9]{22}$Required: No
- Score
-
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either
ACCEPTorREJECT.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
