Documentation

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

See: newAuthenticationResult smart constructor.

Create a value of AuthenticationResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customerSpeakerId:AuthenticationResult', authenticationResult_customerSpeakerId - The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

$sel:score:AuthenticationResult', authenticationResult_score - 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.

$sel:authenticationResultId:AuthenticationResult', authenticationResult_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, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

$sel:decision:AuthenticationResult', authenticationResult_decision - The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

$sel:configuration:AuthenticationResult', authenticationResult_configuration - The AuthenticationConfiguration used to generate this authentication result.

$sel:audioAggregationStartedAt:AuthenticationResult', authenticationResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this authentication result.

$sel:generatedSpeakerId:AuthenticationResult', authenticationResult_generatedSpeakerId - The service-generated identifier for the speaker whose authentication result is produced.

$sel:audioAggregationEndedAt:AuthenticationResult', authenticationResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this authentication result.

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

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.

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.

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

The AuthenticationConfiguration used to generate this authentication result.

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

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

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