eric/notarius
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Classify source relatedness as data-quality advisories

Browse Source
This commit is contained in:
Eric Rakestraw
2026-08-27 15:49:53 +00:00
parent 1f1967c8d2
commit ccba2ce3f9
25 changed files with 232 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
internal/modules/dnd/validate/itemregistry/source_relatedness/validator.go
View File

@@ -1,4 +1,4 @@
// Package sourcerelatedness warns when cited source text does not mention an item.
// Package sourcerelatedness reports advisory findings when cited source text does not mention an item.
package sourcerelatedness
import (
@@ -14,10 +14,9 @@ import (
)
const (
Key = "extract/dnd/item-registry/source_relatedness"
WarningReasonCode = "item_not_near_source"
OmittedReasonCode = "item_relatedness_warnings_omitted"
policy = "dnd.item_registry.validator.source_relatedness.v1"
Key = "extract/dnd/item-registry/source_relatedness"
ReasonCode = "item_not_near_source"
policy = "dnd.item_registry.validator.source_relatedness.v1"
)
type Options struct{}
@@ -57,11 +56,11 @@ func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationReq
continue
}
warnings = append(warnings, contracts.Warning{
Scope: fmt.Sprintf("items[%d]", itemIndex), ReasonCode: WarningReasonCode,
Scope: fmt.Sprintf("items[%d]", itemIndex), ReasonCode: ReasonCode,
Message: fmt.Sprintf("Item %s was not found in cited source text", diagnostics.Quote(item.Name)),
})
}
return contracts.ValidationResult{Approved: true, Warnings: diagnostics.LimitWarnings(warnings, "items", OmittedReasonCode)}, nil
return diagnostics.DataQualityResult(warnings)
}
func Spec() pipeline.ValidatorSpec {

11
internal/modules/dnd/validate/itemregistry/source_relatedness/validator_test.go
View File

@@ -9,32 +9,31 @@ import (
"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/shared/diagnostics"
)
func TestValidatorUsesOnlyCitedTranscriptText(t *testing.T) {
value := dnd.ItemRegistry{Items: []dnd.Item{{ID: "item", Name: "Star Compass", SourceRefs: []source.SourceRef{{SourceID: "session", StartUnitID: 1, EndUnitID: 1}}}}}
doc := &source.SourceDocument{ID: "session", Units: []source.SourceUnit{{ID: 1, Text: "They recover the star compass."}, {ID: 2, Text: "Unrelated text."}}}
result, err := New(Options{}).Validate(context.Background(), contracts.TypedValidationRequest[dnd.ItemRegistry]{Source: doc, Value: value})
if err != nil || !result.Approved || len(result.Warnings) != 0 {
if err != nil || !result.Approved || len(result.Diagnostics) != 0 {
t.Fatalf("cited match = %#v, %v; want approval without warnings", result, err)
}
value.Items[0].Name = "Glossary Relic"
before := value
result, err = New(Options{}).Validate(context.Background(), contracts.TypedValidationRequest[dnd.ItemRegistry]{Source: doc, References: contracts.ReferenceSet{Slots: map[string]contracts.ResolvedReferenceSlot{"glossary": {Items: []contracts.ReferenceItem{{Content: []byte("Glossary Relic")}}}}}, Value: value})
if err != nil || !result.Approved || len(result.Warnings) != 1 || result.Warnings[0].ReasonCode != WarningReasonCode || !reflect.DeepEqual(value, before) {
if err != nil || !result.Approved || len(result.Warnings) != 0 || len(result.Diagnostics) != 1 || result.Diagnostics[0].ReasonCode != ReasonCode || !reflect.DeepEqual(value, before) {
t.Fatalf("reference-only match = %#v, %v; want advisory warning", result, err)
}
}
func TestValidatorBoundsWarningsAndRegisters(t *testing.T) {
items := make([]dnd.Item, diagnostics.MaxWarnings+1)
items := make([]dnd.Item, contracts.MaxDiagnosticSamples+2)
for index := range items {
items[index] = dnd.Item{ID: "item", Name: "Missing", SourceRefs: []source.SourceRef{{SourceID: "session", StartUnitID: 1, EndUnitID: 1}}}
}
result, err := New(Options{}).Validate(context.Background(), contracts.TypedValidationRequest[dnd.ItemRegistry]{Source: &source.SourceDocument{ID: "session", Units: []source.SourceUnit{{ID: 1, Text: "Nothing here."}}}, Value: dnd.ItemRegistry{Items: items}})
if err != nil || !result.Approved || len(result.Warnings) != diagnostics.MaxWarnings || result.Warnings[len(result.Warnings)-1].ReasonCode != OmittedReasonCode {
t.Fatalf("bounded warnings = %#v, %v", result, err)
if err != nil || !result.Approved || len(result.Warnings) != 0 || len(result.Diagnostics) != 1 || result.Diagnostics[0].OccurrenceCount != len(items) || len(result.Diagnostics[0].Samples) != contracts.MaxDiagnosticSamples {
t.Fatalf("bounded advisories = %#v, %v", result, err)
}
registry := pipeline.NewValidatorRegistry()
if err := Register(registry); err != nil {