aws_sdk_voiceid/client/
evaluate_session.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`EvaluateSession`](crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_id(impl Into<String>)`](crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder::set_domain_id):<br>required: **true**<br><p>The identifier of the domain where the session started.</p><br>
    ///   - [`session_name_or_id(impl Into<String>)`](crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder::session_name_or_id) / [`set_session_name_or_id(Option<String>)`](crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder::set_session_name_or_id):<br>required: **true**<br><p>The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.</p><br>
    /// - On success, responds with [`EvaluateSessionOutput`](crate::operation::evaluate_session::EvaluateSessionOutput) with field(s):
    ///   - [`domain_id(Option<String>)`](crate::operation::evaluate_session::EvaluateSessionOutput::domain_id): <p>The identifier of the domain that contains the session.</p>
    ///   - [`session_id(Option<String>)`](crate::operation::evaluate_session::EvaluateSessionOutput::session_id): <p>The service-generated identifier of the session.</p>
    ///   - [`session_name(Option<String>)`](crate::operation::evaluate_session::EvaluateSessionOutput::session_name): <p>The client-provided name of the session.</p>
    ///   - [`streaming_status(Option<StreamingStatus>)`](crate::operation::evaluate_session::EvaluateSessionOutput::streaming_status): <p>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 <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, 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 <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>, 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.</p>
    ///   - [`authentication_result(Option<AuthenticationResult>)`](crate::operation::evaluate_session::EvaluateSessionOutput::authentication_result): <p>Details resulting from the authentication process, such as authentication decision and authentication score.</p>
    ///   - [`fraud_detection_result(Option<FraudDetectionResult>)`](crate::operation::evaluate_session::EvaluateSessionOutput::fraud_detection_result): <p>Details resulting from the fraud detection process, such as fraud detection decision and risk score.</p>
    /// - On failure, responds with [`SdkError<EvaluateSessionError>`](crate::operation::evaluate_session::EvaluateSessionError)
    pub fn evaluate_session(&self) -> crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder {
        crate::operation::evaluate_session::builders::EvaluateSessionFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_voiceid/client/evaluate_session.rs

aws_sdk_voiceid/client/
evaluate_session.rs
