oxibrain-core 0.5.0

Core domain types, temporal fold, extraction, ranking, and packing for oxibrain
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
//! Predicate registry (DESIGN §5.5, P4). Predicate semantics — object type,
//! cardinality, temporality, invalidation, symmetry — declared here, not in prompts.
//! The registry drives the fold, the validator, and (in M3) the extraction schema.

use crate::knowledge::{EntityTypeRef, PredicateRef};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Cardinality {
    Functional,
    MultiValued,
}

impl Cardinality {
    pub fn as_db(&self) -> &'static str {
        match self {
            Self::Functional => "functional",
            Self::MultiValued => "multi_valued",
        }
    }
    pub fn parse_db(s: &str) -> Option<Self> {
        match s {
            "functional" => Some(Self::Functional),
            "multi_valued" => Some(Self::MultiValued),
            _ => None,
        }
    }
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Temporality {
    Static,
    Interval,
    Point,
}

impl Temporality {
    pub fn as_db(&self) -> &'static str {
        match self {
            Self::Static => "static",
            Self::Interval => "interval",
            Self::Point => "point",
        }
    }
    pub fn parse_db(s: &str) -> Option<Self> {
        match s {
            "static" => Some(Self::Static),
            "interval" => Some(Self::Interval),
            "point" => Some(Self::Point),
            _ => None,
        }
    }
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Invalidation {
    Supersede,
    Coexist,
    ExplicitOnly,
}

impl Invalidation {
    pub fn as_db(&self) -> &'static str {
        match self {
            Self::Supersede => "supersede",
            Self::Coexist => "coexist",
            Self::ExplicitOnly => "explicit_only",
        }
    }
    pub fn parse_db(s: &str) -> Option<Self> {
        match s {
            "supersede" => Some(Self::Supersede),
            "coexist" => Some(Self::Coexist),
            "explicit_only" => Some(Self::ExplicitOnly),
            _ => None,
        }
    }
}

/// Entity types a predicate's object may take (registry minor 4+). Serializes
/// as a JSON array; deserialization also accepts the pre-4 single-string form
/// so `def_json` rows written by older registries keep loading.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EntityTypes(pub Vec<EntityTypeRef>);

impl<const N: usize> From<[&str; N]> for EntityTypes {
    fn from(types: [&str; N]) -> Self {
        Self(types.iter().map(|s| (*s).to_string()).collect())
    }
}

impl From<&str> for EntityTypes {
    fn from(t: &str) -> Self {
        Self(vec![t.to_string()])
    }
}

impl Serialize for EntityTypes {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.collect_seq(self.0.iter())
    }
}

impl<'de> Deserialize<'de> for EntityTypes {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        struct EntityTypesVisitor;

        impl<'de> serde::de::Visitor<'de> for EntityTypesVisitor {
            type Value = EntityTypes;

            fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                f.write_str("an entity type string or an array of entity type strings")
            }

            fn visit_str<E>(self, v: &str) -> Result<EntityTypes, E>
            where
                E: serde::de::Error,
            {
                Ok(EntityTypes(vec![v.to_string()]))
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<EntityTypes, A::Error>
            where
                A: serde::de::SeqAccess<'de>,
            {
                let mut out = Vec::with_capacity(seq.size_hint().unwrap_or(0));
                while let Some(t) = seq.next_element::<String>()? {
                    out.push(t);
                }
                Ok(EntityTypes(out))
            }
        }

        deserializer.deserialize_any(EntityTypesVisitor)
    }
}

/// What a predicate's object can be. Untagged; variant order is load-bearing:
/// `Literal` is tried first so literal type names ("text", "date", …) are not
/// swallowed by the string-accepting `Entity` visitor.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ObjectKind {
    Literal(LiteralType),
    Entity(EntityTypes),
    Enum { variants: Vec<String> },
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum LiteralType {
    Text,
    Date,
    DateTime,
    Quantity { unit: String },
    Number,
    Bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PredicateDef {
    pub name: PredicateRef,
    pub object_kind: ObjectKind,
    pub subject_types: Vec<EntityTypeRef>,
    pub cardinality: Cardinality,
    pub temporality: Temporality,
    pub invalidation: Invalidation,
    pub symmetric: bool,
    pub inverse_of: Option<PredicateRef>,
    pub description: String,
    pub examples: Vec<String>,
    pub deprecated_by: Option<PredicateRef>,
    /// §12.2 — predicate is "what the user wants in every answer". A predicate
    /// marked here is queried on every Profile render. Defaults to false.
    /// Bumping this on existing predicates is a minor-version event: existing
    /// cached extractions are unaffected (D21).
    #[serde(default)]
    pub profile_relevant: bool,
    /// §5.5 — confidence prior for this predicate. Defaults to 1.0 (normal
    /// evidence). Hearsay/uncertain predicates (e.g. `allegedly_employed_by`)
    /// carry a lower prior so the fold produces low-confidence beliefs
    /// automatically — no special-casing in the pipeline (P4).
    #[serde(default = "default_confidence_prior")]
    pub confidence_prior: f32,
}

/// Default confidence prior for predicates (§5.5). Normal predicates do not
/// penalise belief confidence; hearsay predicates override this to < 1.0.
fn default_confidence_prior() -> f32 {
    1.0
}
/// Registry version for this ontology.
pub const CORE_V1_MAJOR: u32 = 1;
pub const CORE_V1_MINOR: u32 = 4;

static CORE_V1: std::sync::LazyLock<Vec<PredicateDef>> = std::sync::LazyLock::new(|| {
    vec![
        PredicateDef {
            name: "employed_by".into(),
            object_kind: ObjectKind::Entity("Organization".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: None,
            description: "The organization that employs this person.".into(),
            examples: vec!["Alice is employed by Acme Corp".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "works_on".into(),
            object_kind: ObjectKind::Entity("Project".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "A project this person is currently working on.".into(),
            examples: vec!["Bob works on ProjectX".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "born_in".into(),
            object_kind: ObjectKind::Entity("Place".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Static,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: None,
            description: "Where this person was born. A second value is a contradiction.".into(),
            examples: vec!["Alice was born in Seoul".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "full_name".into(),
            object_kind: ObjectKind::Literal(LiteralType::Text),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: None,
            description: "The person's full legal name. A new value supersedes the old.".into(),
            examples: vec!["Alice's full name is Alice Smith".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "died_at".into(),
            object_kind: ObjectKind::Literal(LiteralType::DateTime),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Static,
            invalidation: Invalidation::ExplicitOnly,
            symmetric: false,
            inverse_of: None,
            description: "When this person died. A second value is a contradiction.".into(),
            examples: vec!["Alice died at 2024-03-01T00:00:00Z".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "knows".into(),
            object_kind: ObjectKind::Entity("Person".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: true,
            inverse_of: None,
            description: "This person knows another person. Symmetric.".into(),
            examples: vec!["Alice knows Bob".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "member_of".into(),
            object_kind: ObjectKind::Entity("Organization".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "Organizations this person is a member of.".into(),
            examples: vec!["Alice is a member of the Engineering Guild".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "part_of".into(),
            object_kind: ObjectKind::Entity(["Organization", "Project"].into()),
            subject_types: vec!["Organization".into(), "Project".into(), "Artifact".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Static,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: None,
            description:
                "This organization/project/artifact is part of a parent organization or project."
                    .into(),
            examples: vec!["Acme subsidiary is part of Acme Corp".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "located_in".into(),
            object_kind: ObjectKind::Entity("Place".into()),
            subject_types: vec!["Place".into(), "Artifact".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Static,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: None,
            description: "This place or artifact is located within a place.".into(),
            examples: vec!["Seoul is located in South Korea".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "has_skill".into(),
            object_kind: ObjectKind::Entity("Concept".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "A skill or competency this person has.".into(),
            examples: vec!["Alice has skill Rust programming".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "created_by".into(),
            object_kind: ObjectKind::Entity("Person".into()),
            subject_types: vec!["Artifact".into(), "Document".into()],
            cardinality: Cardinality::Functional,
            temporality: Temporality::Static,
            invalidation: Invalidation::Supersede,
            symmetric: false,
            inverse_of: Some("author_of".into()),
            description: "Who created this artifact or document.".into(),
            examples: vec!["The report was created by Alice".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 1.0,
        },
        PredicateDef {
            name: "aliases".into(),
            object_kind: ObjectKind::Literal(LiteralType::Text),
            subject_types: vec![
                "Person".into(),
                "Organization".into(),
                "Project".into(),
                "Artifact".into(),
            ],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Static,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "Alternative names for this entity. Multiple values coexist.".into(),
            examples: vec!["Alice's alias is A. Smith".into()],
            deprecated_by: None,
            profile_relevant: true,
            confidence_prior: 1.0,
        },
        // ── Hearsay / uncertain predicates (§5.5, M10 10.9) ──────────────
        // These carry a low confidence_prior so beliefs derived from them
        // are automatically down-weighted by the fold. No pipeline
        // special-casing required (P4: semantics in the registry).
        PredicateDef {
            name: "allegedly_employed_by".into(),
            object_kind: ObjectKind::Entity("Organization".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "Unverified claim that an organization employs this person.".into(),
            examples: vec!["Alice is allegedly employed by Acme Corp".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 0.3,
        },
        PredicateDef {
            name: "rumored_knows".into(),
            object_kind: ObjectKind::Entity("Person".into()),
            subject_types: vec!["Person".into()],
            cardinality: Cardinality::MultiValued,
            temporality: Temporality::Interval,
            invalidation: Invalidation::Coexist,
            symmetric: false,
            inverse_of: None,
            description: "Unverified claim that this person knows another person.".into(),
            examples: vec!["Alice is rumored to know Bob".into()],
            deprecated_by: None,
            profile_relevant: false,
            confidence_prior: 0.3,
        },
    ]
});

/// The shipped core/v1 ontology (DESIGN §5.5).
pub fn core_v1() -> &'static Vec<PredicateDef> {
    &CORE_V1
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    #[test]
    fn core_v1_covers_all_invalidation_branches() {
        let defs = core_v1();
        // Must have at least one predicate for each branch we need to test:
        let has_func_supersede_interval = defs.iter().any(|d| {
            d.cardinality == Cardinality::Functional
                && d.invalidation == Invalidation::Supersede
                && d.temporality == Temporality::Interval
        });
        let has_func_supersede_static = defs.iter().any(|d| {
            d.cardinality == Cardinality::Functional
                && d.invalidation == Invalidation::Supersede
                && d.temporality == Temporality::Static
        });
        let has_multi_coexist = defs.iter().any(|d| {
            d.cardinality == Cardinality::MultiValued && d.invalidation == Invalidation::Coexist
        });
        let has_explicit_only = defs
            .iter()
            .any(|d| d.invalidation == Invalidation::ExplicitOnly);
        let has_symmetric = defs.iter().any(|d| d.symmetric);
        let has_inverse = defs.iter().any(|d| d.inverse_of.is_some());

        assert!(
            has_func_supersede_interval,
            "missing Functional/Supersede/Interval"
        );
        assert!(
            has_func_supersede_static,
            "missing Functional/Supersede/Static"
        );
        assert!(has_multi_coexist, "missing MultiValued/Coexist");
        assert!(has_explicit_only, "missing ExplicitOnly");
        assert!(has_symmetric, "missing symmetric");
        assert!(has_inverse, "missing inverse_of");
    }

    #[test]
    fn predicate_names_are_unique() {
        let names: HashSet<_> = core_v1().iter().map(|d| &d.name).collect();
        assert_eq!(names.len(), core_v1().len(), "duplicate predicate names");
    }

    #[test]
    fn predicate_defs_serialize_roundtrip() {
        for def in core_v1() {
            let json = serde_json::to_string(def).expect("serialize");
            let back: PredicateDef = serde_json::from_str(&json).expect("deserialize");
            assert_eq!(def.name, back.name);
            assert_eq!(def.cardinality, back.cardinality);
            assert_eq!(def.temporality, back.temporality);
            assert_eq!(def.invalidation, back.invalidation);
        }
    }

    #[test]
    fn part_of_accepts_multiple_object_types() {
        // The regression this redesign exists for: project-part-of-project
        // knowledge must survive validation (minor 4).
        let def = core_v1()
            .iter()
            .find(|d| d.name == "part_of")
            .expect("part_of");
        let ObjectKind::Entity(types) = &def.object_kind else {
            panic!("part_of object must be Entity");
        };
        assert!(types.0.iter().any(|t| t == "Organization"));
        assert!(types.0.iter().any(|t| t == "Project"));
    }

    #[test]
    fn object_kind_entity_roundtrips_through_array() {
        let def = core_v1()
            .iter()
            .find(|d| d.name == "part_of")
            .expect("part_of");
        let json = serde_json::to_string(&def.object_kind).expect("serialize");
        assert_eq!(json, r#"["Organization","Project"]"#);
        let back: ObjectKind = serde_json::from_str(&json).expect("deserialize");
        assert_eq!(back, def.object_kind);
    }

    #[test]
    fn object_kind_accepts_legacy_single_string() {
        // def_json rows written by registry minor <= 3 stored Entity as a
        // bare string; they must keep loading (no migration required).
        let k: ObjectKind = serde_json::from_str(r#""Organization""#).expect("legacy string");
        assert_eq!(k, ObjectKind::Entity(["Organization"].into()));
    }

    #[test]
    fn object_kind_literal_strings_stay_literal() {
        // Variant-order guard: Literal is tried before Entity so literal type
        // names are not swallowed by the string-accepting Entity visitor.
        let k: ObjectKind = serde_json::from_str(r#""text""#).expect("literal");
        assert_eq!(k, ObjectKind::Literal(LiteralType::Text));
    }

    #[test]
    fn object_kind_enum_uses_object_shape() {
        // Enum moved from a bare array (ambiguous with multi-type Entity) to
        // an object shape under untagged serde. No core/v1 predicate uses it.
        let k: ObjectKind = serde_json::from_str(r#"{"variants":["yes","no"]}"#).expect("enum");
        assert_eq!(
            k,
            ObjectKind::Enum {
                variants: vec!["yes".into(), "no".into()]
            }
        );
        let json = serde_json::to_string(&k).expect("serialize");
        assert_eq!(json, r#"{"variants":["yes","no"]}"#);
    }
}