Interface: DocumentAnalysisReport
@kortexya/reasoninglayer / DocumentAnalysisReport
Interface: DocumentAnalysisReport
Section titled “Interface: DocumentAnalysisReport”Defined in: src/types/documents.ts:212
Complete document-analysis report.
Properties
Section titled “Properties”documents
Section titled “documents”documents:
DocumentResult[]
Defined in: src/types/documents.ts:214
Per-document results.
overallCompliance
Section titled “overallCompliance”overallCompliance:
number|null
Defined in: src/types/documents.ts:224
Overall compliance score (0.0-1.0): the passed share of the applicable rules of the documents read in full.
Remarks
Section titled “Remarks”null when no such rule was evaluated, because nothing evaluated shows
nothing about compliance. The rules of a truncated document are not
counted.
totalRulesEvaluated
Section titled “totalRulesEvaluated”totalRulesEvaluated:
number
Defined in: src/types/documents.ts:226
Total rules evaluated across all documents.
totalRulesFailed
Section titled “totalRulesFailed”totalRulesFailed:
number
Defined in: src/types/documents.ts:230
Total rules that failed.
totalRulesPassed
Section titled “totalRulesPassed”totalRulesPassed:
number
Defined in: src/types/documents.ts:228
Total rules that passed.