systemprompt-models 0.77.0

Foundation data models for systemprompt.io AI governance infrastructure. Shared DTOs, config, and domain types consumed by every layer of the MCP governance pipeline.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! A fact an extractor proposes, before validation, dedupe and routing.
//!
//! Copyright (c) systemprompt.io — Business Source License 1.1.
//! See <https://systemprompt.io> for licensing details.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use systemprompt_identifiers::{FactKindId, TopicId};

use super::scope::FactScope;
use super::source::FactSource;
use super::subject::SubjectKey;

/// An unvalidated fact. `scope` is `None` when routing decides it.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
pub struct FactCandidate {
    pub kind: FactKindId,
    pub subject: SubjectKey,
    // JSON: candidate fields arrive from extractor output and are checked against the kind.
    pub fields: serde_json::Map<String, serde_json::Value>,
    pub source: FactSource,
    pub topics: Vec<TopicId>,
    pub scope: Option<FactScope>,
    pub extractor: String,
    pub confidence: Option<f32>,
}

impl FactCandidate {
    #[must_use]
    pub fn builder(
        kind: FactKindId,
        subject: SubjectKey,
        source: FactSource,
    ) -> FactCandidateBuilder {
        FactCandidateBuilder {
            candidate: Self {
                kind,
                subject,
                fields: serde_json::Map::new(),
                source,
                topics: Vec::new(),
                scope: None,
                extractor: String::new(),
                confidence: None,
            },
        }
    }
}

/// Builds a [`FactCandidate`] from its kind, subject and source.
#[derive(Debug, Clone)]
pub struct FactCandidateBuilder {
    candidate: FactCandidate,
}

impl FactCandidateBuilder {
    #[must_use]
    // JSON: candidate field values are free-form until validated against the kind.
    pub fn field(mut self, name: impl Into<String>, value: serde_json::Value) -> Self {
        self.candidate.fields.insert(name.into(), value);
        self
    }

    #[must_use]
    // JSON: candidate fields arrive from extractor output and are checked against
    // the kind.
    pub fn fields(mut self, fields: serde_json::Map<String, serde_json::Value>) -> Self {
        self.candidate.fields = fields;
        self
    }

    #[must_use]
    pub fn topic(mut self, topic: TopicId) -> Self {
        self.candidate.topics.push(topic);
        self
    }

    #[must_use]
    pub fn scope(mut self, scope: FactScope) -> Self {
        self.candidate.scope = Some(scope);
        self
    }

    #[must_use]
    pub fn extractor(mut self, extractor: impl Into<String>) -> Self {
        self.candidate.extractor = extractor.into();
        self
    }

    #[must_use]
    pub const fn confidence(mut self, confidence: f32) -> Self {
        self.candidate.confidence = Some(confidence);
        self
    }

    #[must_use]
    pub fn build(self) -> FactCandidate {
        self.candidate
    }
}