Interface: DocumentRuleResult

@kortexya/reasoninglayer

---

@kortexya/reasoninglayer / Documents / DocumentRuleResult

Interface: DocumentRuleResult

Defined in: src/types/documents.ts:73

Result of evaluating one rule against a document.

Properties

confidence

confidence: number

Defined in: src/types/documents.ts:85

Confidence in the result (0.0-1.0).

---

evidence

evidence: string[]

Defined in: src/types/documents.ts:87

Evidence supporting the result.

---

fixSuggestion?

optional fixSuggestion: string | null

Defined in: src/types/documents.ts:91

Fix suggestion (when requested and the rule failed).

---

proofTrace?

optional proofTrace: DocumentProofStep[] | null

Defined in: src/types/documents.ts:89

Proof trace (when requested): chain of reasoning steps.

---

relevantExcerpt?

optional relevantExcerpt: string | null

Defined in: src/types/documents.ts:93

The relevant clause/section excerpt of the document.

---

ruleDescription

ruleDescription: string

Defined in: src/types/documents.ts:77

Human-readable rule description.

---

ruleId

ruleId: string

Defined in: src/types/documents.ts:75

Rule identifier (sort name + feature key).

---

ruleSort

ruleSort: string

Defined in: src/types/documents.ts:79

Which rule sort/category this belongs to.

---

severity

severity: DocumentRuleSeverity

Defined in: src/types/documents.ts:81

Rule severity.

---

status

status: DocumentRuleStatus

Defined in: src/types/documents.ts:83

Whether the rule passed/failed/was inconclusive/not applicable.