AuthenticationResult

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

Type: Timestamp

Required: No

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

Type: Timestamp

Required: No

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.

Type: String

Length Constraints: Fixed length of 22.

Pattern: [a-zA-Z0-9]{22}

Required: No

The AuthenticationConfiguration used to generate this authentication result.

Type: AuthenticationConfiguration object

Required: No

The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is 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

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_EXPIRED

Required: No

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

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No