Interface: CheckFinding

@kortexya/reasoninglayer / DocumentCheck / CheckFinding

Interface: CheckFinding

Defined in: src/types/document-check.ts:98

One unified finding, from either the OSF diff pass or the rules pass.

Remarks

Findings carry two-sided provenance: CheckFinding.evidenceDocument is the span in the checked contract, CheckFinding.evidenceReference the span in the reference document. The details and proofTrace payloads are pass-specific opaque JSON (the full clause diff item / contradiction record / rule proof chain) and are surfaced verbatim.

Properties

details?

optional details: JsonValue

Defined in: src/types/document-check.ts:114

Pass-specific detail payload (clause diff item, contradiction record, rule result).

evidenceDocument?

optional evidenceDocument: JsonValue

Defined in: src/types/document-check.ts:110

Provenance in the checked contract, when present on that side.

evidenceReference?

optional evidenceReference: JsonValue

Defined in: src/types/document-check.ts:112

Provenance in the reference document, when present on that side.

fixSuggestion?

optional fixSuggestion: string | null

Defined in: src/types/document-check.ts:118

Suggested fix, when requested and derivable.

kind

kind: FindingKind

Defined in: src/types/document-check.ts:102

Kind of the finding.

message

message: string

Defined in: src/types/document-check.ts:104

Human-readable description.

proofTrace?

optional proofTrace: JsonValue

Defined in: src/types/document-check.ts:116

Proof trace for rule-violation findings, when requested.

referenceDocumentId?

optional referenceDocumentId: string | null

Defined in: src/types/document-check.ts:108

Which reference document produced this finding (OSF-diff findings only).

severity

severity: FindingSeverity

Defined in: src/types/document-check.ts:100

Severity of the finding.

source

source: string

Defined in: src/types/document-check.ts:106

Which pass produced this finding: "osf_diff" or "kb_rules".