Interface: DocumentSummary
@kortexya/reasoninglayer / DocumentSummary
Interface: DocumentSummary
Section titled “Interface: DocumentSummary”Defined in: src/types/documents.ts:344
Enrichment artifacts persisted for a document, plus registry metadata.
Remarks
Section titled “Remarks”summary and keyPoints are features on the document Ψ-term; they are absent
(null / empty) when enrichment did not run at ingestion time. status falls
back to "unknown" when no registry row exists for the document.
Properties
Section titled “Properties”chunkCount
Section titled “chunkCount”chunkCount:
number
Defined in: src/types/documents.ts:358
Number of chunks.
clauseCount
Section titled “clauseCount”clauseCount:
number
Defined in: src/types/documents.ts:362
Number of extracted clauses.
createdAt?
Section titled “createdAt?”
optionalcreatedAt?:string|null
Defined in: src/types/documents.ts:364
Creation timestamp (RFC 3339), when a registry row exists.
entityCount
Section titled “entityCount”entityCount:
number
Defined in: src/types/documents.ts:360
Number of linked entities.
id:
string
Defined in: src/types/documents.ts:346
Document id.
keyPoints
Section titled “keyPoints”keyPoints:
string[]
Defined in: src/types/documents.ts:352
LLM-generated key points.
name:
string
Defined in: src/types/documents.ts:348
Display name.
qaPairs
Section titled “qaPairs”qaPairs:
DocumentQaPair[]
Defined in: src/types/documents.ts:354
Generated Q&A pairs (document.qa terms).
status
Section titled “status”status:
string
Defined in: src/types/documents.ts:356
Lifecycle status — one of DocumentStatus, or "unknown".
summary?
Section titled “summary?”
optionalsummary?:string|null
Defined in: src/types/documents.ts:350
LLM-generated summary (null when enrichment didn’t run).