Signet Forge 0.1.0
C++20 Parquet library with AI-native extensions
DEMO
Loading...
Searching...
No Matches
signet::forge::ReportOptions Struct Reference

Query and formatting parameters for compliance report generation. More...

#include <compliance_types.hpp>

Public Attributes

int64_t start_ns = 0
 Inclusive start of the reporting period (nanoseconds since Unix epoch).
 
int64_t end_ns = (std::numeric_limits<int64_t>::max)()
 Inclusive end of the reporting period (nanoseconds since Unix epoch).
 
ReportFormat format = ReportFormat::JSON
 Output serialization format.
 
bool verify_chain = true
 If true, verify the hash chain of each log file before generating the report and record the result in ComplianceReport::chain_verified.
 
bool strict_source_reads = true
 If true, any source-log read failure aborts report generation instead of producing an incomplete regulatory artifact.
 
bool include_features = false
 If true, include raw input feature vectors in the report output.
 
bool pretty_print = true
 If true, emit human-readable indented JSON (2-space indent).
 
std::string system_id
 Logical identifier for the AI system being reported on.
 
std::string report_id
 Optional: unique identifier for this report filing.
 
std::string firm_id
 Organisation / firm identifier for MiFID II field 1.
 
float low_confidence_threshold = 0.5f
 Low-confidence threshold for EU AI Act anomaly counting.
 
int price_significant_digits = 17
 Significant digits for price fields (MiFID II RTS 24 Annex I Field 6).
 
TimestampGranularity timestamp_granularity = TimestampGranularity::NANOS
 Timestamp sub-second granularity (MiFID II RTS 24 Art.2(2)).
 
std::string intended_purpose
 Art.13(3)(b)(i): Intended purpose of the AI system.
 
std::string known_limitations
 Art.13(3)(b)(ii): Known limitations and foreseeable misuse risks.
 
std::string provider_name
 Art.13(3)(a): Provider name and contact information.
 
std::string provider_contact
 
std::string instructions_for_use
 Art.13(3)(b)(iv): Instructions for use / deployment guidance.
 
std::string human_oversight_measures
 Art.14: Human oversight measures description.
 
std::string accuracy_metrics
 Art.15: Accuracy metrics description (e.g. "F1=0.94 on test set v3").
 
std::string bias_risks
 Art.15: Known biases or fairness concerns.
 
int risk_level {0}
 Art.9: Risk classification level (1=minimal, 2=limited, 3=high, 4=unacceptable).
 

Detailed Description

Query and formatting parameters for compliance report generation.

Shared by MiFID2Reporter and EUAIActReporter. Controls the time window, output format, chain verification, and report identification fields.

Note
Defined at namespace scope (not nested) for Apple Clang compatibility.

Definition at line 56 of file compliance_types.hpp.

Member Data Documentation

◆ accuracy_metrics

std::string signet::forge::ReportOptions::accuracy_metrics

Art.15: Accuracy metrics description (e.g. "F1=0.94 on test set v3").

Definition at line 127 of file compliance_types.hpp.

◆ bias_risks

std::string signet::forge::ReportOptions::bias_risks

Art.15: Known biases or fairness concerns.

Definition at line 130 of file compliance_types.hpp.

◆ end_ns

int64_t signet::forge::ReportOptions::end_ns = (std::numeric_limits<int64_t>::max)()

Inclusive end of the reporting period (nanoseconds since Unix epoch).

Default: no upper bound.

Definition at line 63 of file compliance_types.hpp.

◆ firm_id

std::string signet::forge::ReportOptions::firm_id

Organisation / firm identifier for MiFID II field 1.

Example: LEI code (20-char alphanumeric) or internal firm ID.

Definition at line 94 of file compliance_types.hpp.

◆ format

ReportFormat signet::forge::ReportOptions::format = ReportFormat::JSON

Output serialization format.

Definition at line 66 of file compliance_types.hpp.

◆ human_oversight_measures

std::string signet::forge::ReportOptions::human_oversight_measures

Art.14: Human oversight measures description.

Definition at line 124 of file compliance_types.hpp.

◆ include_features

bool signet::forge::ReportOptions::include_features = false

If true, include raw input feature vectors in the report output.

Default false: omit raw features (typically proprietary alpha signals). Regulators generally require only input hashes, not raw values.

Definition at line 79 of file compliance_types.hpp.

◆ instructions_for_use

std::string signet::forge::ReportOptions::instructions_for_use

Art.13(3)(b)(iv): Instructions for use / deployment guidance.

Definition at line 121 of file compliance_types.hpp.

◆ intended_purpose

std::string signet::forge::ReportOptions::intended_purpose

Art.13(3)(b)(i): Intended purpose of the AI system.

Definition at line 111 of file compliance_types.hpp.

◆ known_limitations

std::string signet::forge::ReportOptions::known_limitations

Art.13(3)(b)(ii): Known limitations and foreseeable misuse risks.

Definition at line 114 of file compliance_types.hpp.

◆ low_confidence_threshold

float signet::forge::ReportOptions::low_confidence_threshold = 0.5f

Low-confidence threshold for EU AI Act anomaly counting.

Inferences with confidence below this value are flagged.

Definition at line 98 of file compliance_types.hpp.

◆ pretty_print

bool signet::forge::ReportOptions::pretty_print = true

If true, emit human-readable indented JSON (2-space indent).

Definition at line 82 of file compliance_types.hpp.

◆ price_significant_digits

int signet::forge::ReportOptions::price_significant_digits = 17

Significant digits for price fields (MiFID II RTS 24 Annex I Field 6).

Default 17 preserves full double-precision round-trip fidelity.

Definition at line 102 of file compliance_types.hpp.

◆ provider_contact

std::string signet::forge::ReportOptions::provider_contact

Definition at line 118 of file compliance_types.hpp.

◆ provider_name

std::string signet::forge::ReportOptions::provider_name

Art.13(3)(a): Provider name and contact information.

Definition at line 117 of file compliance_types.hpp.

◆ report_id

std::string signet::forge::ReportOptions::report_id

Optional: unique identifier for this report filing.

If empty, auto-generated from timestamp.

Definition at line 90 of file compliance_types.hpp.

◆ risk_level

int signet::forge::ReportOptions::risk_level {0}

Art.9: Risk classification level (1=minimal, 2=limited, 3=high, 4=unacceptable).

Definition at line 133 of file compliance_types.hpp.

◆ start_ns

int64_t signet::forge::ReportOptions::start_ns = 0

Inclusive start of the reporting period (nanoseconds since Unix epoch).

Default: beginning of time.

Definition at line 59 of file compliance_types.hpp.

◆ strict_source_reads

bool signet::forge::ReportOptions::strict_source_reads = true

If true, any source-log read failure aborts report generation instead of producing an incomplete regulatory artifact.

Definition at line 74 of file compliance_types.hpp.

◆ system_id

std::string signet::forge::ReportOptions::system_id

Logical identifier for the AI system being reported on.

Appears in EU AI Act reports as the "system_id" field.

Definition at line 86 of file compliance_types.hpp.

◆ timestamp_granularity

TimestampGranularity signet::forge::ReportOptions::timestamp_granularity = TimestampGranularity::NANOS

Timestamp sub-second granularity (MiFID II RTS 24 Art.2(2)).

Default NANOS for HFT regulatory compliance.

Definition at line 106 of file compliance_types.hpp.

◆ verify_chain

bool signet::forge::ReportOptions::verify_chain = true

If true, verify the hash chain of each log file before generating the report and record the result in ComplianceReport::chain_verified.

Definition at line 70 of file compliance_types.hpp.


The documentation for this struct was generated from the following file: