Interface: CheckFinding
@kortexya/reasoninglayer / CheckFinding
Interface: CheckFinding
Section titled “Interface: CheckFinding”Defined in: src/types/document-check.ts:144
One unified finding, from either the OSF diff pass or the rules pass.
Remarks
Section titled “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 payload is pass-specific opaque
JSON (the full clause diff item, contradiction record or rule result) and is
surfaced verbatim. proofTrace is typed.
The knowledge-base rules pass produces one rule_violation finding
(source: "kb_rules", message "Rule violated: <description>") per rule
that fails. A rule it cannot evaluate adds a line to
CheckDocumentResponse.warnings, not a finding.
Properties
Section titled “Properties”details?
Section titled “details?”
optionaldetails?:JsonValue
Defined in: src/types/document-check.ts:160
Pass-specific detail payload (clause diff item, contradiction record, rule result).
evidenceDocument?
Section titled “evidenceDocument?”
optionalevidenceDocument?:JsonValue
Defined in: src/types/document-check.ts:156
Provenance in the checked contract, when present on that side.
evidenceReference?
Section titled “evidenceReference?”
optionalevidenceReference?:JsonValue
Defined in: src/types/document-check.ts:158
Provenance in the reference document, when present on that side.
fixSuggestion?
Section titled “fixSuggestion?”
optionalfixSuggestion?:string|null
Defined in: src/types/document-check.ts:167
Suggested fix, when requested and derivable.
kind:
FindingKind
Defined in: src/types/document-check.ts:148
Kind of the finding.
message
Section titled “message”message:
string
Defined in: src/types/document-check.ts:150
Human-readable description.
proofTrace?
Section titled “proofTrace?”
optionalproofTrace?:CheckProofStep[] |null
Defined in: src/types/document-check.ts:165
Proof trace of a rule_violation finding, when requested: the ordered
reasoning steps. Absent on other findings.
referenceDocumentId?
Section titled “referenceDocumentId?”
optionalreferenceDocumentId?:string|null
Defined in: src/types/document-check.ts:154
Which reference document produced this finding (OSF-diff findings only).
severity
Section titled “severity”severity:
FindingSeverity
Defined in: src/types/document-check.ts:146
Severity of the finding.
source
Section titled “source”source:
string
Defined in: src/types/document-check.ts:152
Which pass produced this finding: "osf_diff" or "kb_rules".