Struct AuthenticationResult

#[non_exhaustive]
pub struct AuthenticationResult {
    pub authentication_result_id: Option<String>,
    pub audio_aggregation_started_at: Option<DateTime>,
    pub audio_aggregation_ended_at: Option<DateTime>,
    pub customer_speaker_id: Option<String>,
    pub generated_speaker_id: Option<String>,
    pub decision: Option<AuthenticationDecision>,
    pub score: Option<i32>,
    pub configuration: Option<AuthenticationConfiguration>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

authentication_result_id: Option<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.

audio_aggregation_started_at: Option<DateTime>

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

audio_aggregation_ended_at: Option<DateTime>

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

customer_speaker_id: Option<String>

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

generated_speaker_id: Option<String>

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

decision: Option<AuthenticationDecision>

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

score: Option<i32>

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.

configuration: Option<AuthenticationConfiguration>

The AuthenticationConfiguration used to generate this authentication result.

Implementations

impl AuthenticationResult

pub fn authentication_result_id(&self) -> Option<&str>

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.

pub fn audio_aggregation_started_at(&self) -> Option<&DateTime>

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

pub fn audio_aggregation_ended_at(&self) -> Option<&DateTime>

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

pub fn customer_speaker_id(&self) -> Option<&str>

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

pub fn generated_speaker_id(&self) -> Option<&str>

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

pub fn decision(&self) -> Option<&AuthenticationDecision>

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

pub fn score(&self) -> Option<i32>

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.

pub fn configuration(&self) -> Option<&AuthenticationConfiguration>

The AuthenticationConfiguration used to generate this authentication result.

impl AuthenticationResult

pub fn builder() -> AuthenticationResultBuilder

Creates a new builder-style object to manufacture AuthenticationResult.

Trait Implementations

impl Clone for AuthenticationResult

fn clone(&self) -> AuthenticationResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthenticationResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AuthenticationResult

fn eq(&self, other: &AuthenticationResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AuthenticationResult