Interface: CheckDocumentResponse
@kortexya/reasoninglayer / DocumentCheck / CheckDocumentResponse
Interface: CheckDocumentResponse
Defined in: src/types/document-check.ts:141
Result of a contract check.
Remarks
CheckDocumentResponse.warnings explains any pass that was skipped (e.g. the rules pass when no inline content was supplied) — an empty findings list with warnings is not the same as a clean contract.
Properties
diffs
diffs:
JsonValue[]
Defined in: src/types/document-check.ts:147
Full OSF diff report per reference document (opaque JSON).
documentId?
optionaldocumentId:string|null
Defined in: src/types/document-check.ts:143
The checked contract’s document id (newly created when inline content was ingested).
findings
findings:
CheckFinding[]
Defined in: src/types/document-check.ts:145
Unified findings, ordered critical-first.
kbRuleReport?
optionalkbRuleReport:JsonValue
Defined in: src/types/document-check.ts:149
The knowledge-base rules report, when the rules pass ran (opaque JSON).
summary
summary:
CheckSummary
Defined in: src/types/document-check.ts:153
Finding counts by severity.
warnings
warnings:
string[]
Defined in: src/types/document-check.ts:151
Warnings about skipped passes.