Interface: DocumentRuleResult
@kortexya/reasoninglayer / DocumentRuleResult
Interface: DocumentRuleResult
Section titled “Interface: DocumentRuleResult”Defined in: src/types/documents.ts:110
Result of evaluating one rule against a document.
Properties
Section titled “Properties”basis?
Section titled “basis?”
optionalbasis?:DocumentVerdictBasis|null
Defined in: src/types/documents.ts:151
What the evaluator said its verdict rests on. null when it named no
basis the engine can read; absent from an engine that predates it.
confidence
Section titled “confidence”confidence:
number
Defined in: src/types/documents.ts:127
The evaluator’s confidence in status (0.0-1.0). 0 when the
engine withheld the evaluator’s answer: no evaluator answered the
replacement inconclusive, and the withheld answer’s confidence is in
withheldConfidence.
evidence
Section titled “evidence”evidence:
string[]
Defined in: src/types/documents.ts:129
Evidence supporting the result.
fixSuggestion?
Section titled “fixSuggestion?”
optionalfixSuggestion?:string|null
Defined in: src/types/documents.ts:133
Fix suggestion (when requested and the rule failed).
proofTrace?
Section titled “proofTrace?”
optionalproofTrace?:DocumentProofStep[] |null
Defined in: src/types/documents.ts:131
Proof trace (when requested): chain of reasoning steps.
relevantExcerpt?
Section titled “relevantExcerpt?”
optionalrelevantExcerpt?:string|null
Defined in: src/types/documents.ts:135
The relevant clause/section excerpt of the document.
ruleDescription
Section titled “ruleDescription”ruleDescription:
string
Defined in: src/types/documents.ts:114
Human-readable rule description.
ruleId
Section titled “ruleId”ruleId:
string
Defined in: src/types/documents.ts:112
Rule identifier (sort name + feature key).
ruleSort
Section titled “ruleSort”ruleSort:
string
Defined in: src/types/documents.ts:116
Which rule sort/category this belongs to.
severity
Section titled “severity”severity:
DocumentRuleSeverity
Defined in: src/types/documents.ts:118
Rule severity.
status
Section titled “status”status:
DocumentRuleStatus
Defined in: src/types/documents.ts:120
Whether the rule passed/failed/was inconclusive/not applicable.
withheldConfidence?
Section titled “withheldConfidence?”
optionalwithheldConfidence?:number|null
Defined in: src/types/documents.ts:157
The evaluator’s confidence in withheldStatus (0.0-1.0). null
when the evaluator’s status stands; absent from an engine that predates
it.
withheldStatus?
Section titled “withheldStatus?”
optionalwithheldStatus?:DocumentRuleStatus|null
Defined in: src/types/documents.ts:146
The verdict the engine WITHHELD: the status the evaluator answered when the
engine replaced it with inconclusive because the answer was not grounded
in the evaluated text (it quoted nothing the engine read). null when the
evaluator’s status stands; absent from an engine that predates it.
Remarks
Section titled “Remarks”Show it beside an inconclusive result: it explains why a rule the
evaluator called pass or fail is reported as undecided.