Struct AutomatedReasoningPolicyVariableReport 

#[non_exhaustive]
pub struct AutomatedReasoningPolicyVariableReport {
    pub policy_variable: String,
    pub grounding_statements: Option<Vec<AutomatedReasoningPolicyStatementReference>>,
    pub grounding_justifications: Option<Vec<String>>,
    pub accuracy_score: Option<f64>,
    pub accuracy_justification: Option<String>,
}

Provides detailed fidelity analysis for a specific policy variable, including which source document statements support it and how accurate the variable definition is.

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.

policy_variable: String

The name of the policy variable being analyzed in this report.

grounding_statements: Option<Vec<AutomatedReasoningPolicyStatementReference>>

References to statements from the source documents that provide the basis or justification for this variable.

grounding_justifications: Option<Vec<String>>

Explanations describing how the source statements support and justify this specific variable definition.

accuracy_score: Option<f64>

A score from 0.0 to 1.0 indicating how accurately this variable represents concepts from the source material.

accuracy_justification: Option<String>

A textual explanation of the accuracy score, describing why the variable received this particular accuracy rating.

Implementations

impl AutomatedReasoningPolicyVariableReport

pub fn policy_variable(&self) -> &str

The name of the policy variable being analyzed in this report.

pub fn grounding_statements( &self, ) -> &[AutomatedReasoningPolicyStatementReference]

References to statements from the source documents that provide the basis or justification for this variable.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .grounding_statements.is_none().

pub fn grounding_justifications(&self) -> &[String]

Explanations describing how the source statements support and justify this specific variable definition.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .grounding_justifications.is_none().

pub fn accuracy_score(&self) -> Option<f64>

A score from 0.0 to 1.0 indicating how accurately this variable represents concepts from the source material.

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

A textual explanation of the accuracy score, describing why the variable received this particular accuracy rating.

impl AutomatedReasoningPolicyVariableReport

pub fn builder() -> AutomatedReasoningPolicyVariableReportBuilder

Creates a new builder-style object to manufacture AutomatedReasoningPolicyVariableReport.

Trait Implementations

impl Clone for AutomatedReasoningPolicyVariableReport

fn clone(&self) -> AutomatedReasoningPolicyVariableReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutomatedReasoningPolicyVariableReport

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

Formats the value using the given formatter.

impl PartialEq for AutomatedReasoningPolicyVariableReport

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