Struct EvaluateSessionOutput

#[non_exhaustive]
pub struct EvaluateSessionOutput {
    pub domain_id: Option<String>,
    pub session_id: Option<String>,
    pub session_name: Option<String>,
    pub streaming_status: Option<StreamingStatus>,
    pub authentication_result: Option<AuthenticationResult>,
    pub fraud_detection_result: Option<FraudDetectionResult>,
    /* private fields */
}

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.

domain_id: Option<String>

The identifier of the domain that contains the session.

session_id: Option<String>

The service-generated identifier of the session.

session_name: Option<String>

The client-provided name of the session.

streaming_status: Option<StreamingStatus>

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

authentication_result: Option<AuthenticationResult>

Details resulting from the authentication process, such as authentication decision and authentication score.

fraud_detection_result: Option<FraudDetectionResult>

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

Implementations

impl EvaluateSessionOutput

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

The identifier of the domain that contains the session.

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

The service-generated identifier of the session.

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

The client-provided name of the session.

pub fn streaming_status(&self) -> Option<&StreamingStatus>

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

pub fn authentication_result(&self) -> Option<&AuthenticationResult>

Details resulting from the authentication process, such as authentication decision and authentication score.

pub fn fraud_detection_result(&self) -> Option<&FraudDetectionResult>

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

impl EvaluateSessionOutput

pub fn builder() -> EvaluateSessionOutputBuilder

Creates a new builder-style object to manufacture EvaluateSessionOutput.

Trait Implementations

impl Clone for EvaluateSessionOutput

fn clone(&self) -> EvaluateSessionOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EvaluateSessionOutput

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

Formats the value using the given formatter.

impl PartialEq for EvaluateSessionOutput

fn eq(&self, other: &EvaluateSessionOutput) -> 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 RequestId for EvaluateSessionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for EvaluateSessionOutput