Interface: DocumentRuleResult
@kortexya/reasoninglayer / Documents / DocumentRuleResult
Interface: DocumentRuleResult
Defined in: src/types/documents.ts:84
Result of evaluating one rule against a document.
Properties
confidence
confidence:
number
Defined in: src/types/documents.ts:96
Confidence in the result (0.0-1.0).
evidence
evidence:
string[]
Defined in: src/types/documents.ts:98
Evidence supporting the result.
fixSuggestion?
optionalfixSuggestion:string|null
Defined in: src/types/documents.ts:102
Fix suggestion (when requested and the rule failed).
proofTrace?
optionalproofTrace:DocumentProofStep[] |null
Defined in: src/types/documents.ts:100
Proof trace (when requested): chain of reasoning steps.
relevantExcerpt?
optionalrelevantExcerpt:string|null
Defined in: src/types/documents.ts:104
The relevant clause/section excerpt of the document.
ruleDescription
ruleDescription:
string
Defined in: src/types/documents.ts:88
Human-readable rule description.
ruleId
ruleId:
string
Defined in: src/types/documents.ts:86
Rule identifier (sort name + feature key).
ruleSort
ruleSort:
string
Defined in: src/types/documents.ts:90
Which rule sort/category this belongs to.
severity
severity:
DocumentRuleSeverity
Defined in: src/types/documents.ts:92
Rule severity.
status
status:
DocumentRuleStatus
Defined in: src/types/documents.ts:94
Whether the rule passed/failed/was inconclusive/not applicable.