Skip to content

Interface: DocumentSummary

@kortexya/reasoninglayer


@kortexya/reasoninglayer / Documents / DocumentSummary

Interface: DocumentSummary

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

Enrichment artifacts persisted for a document, plus registry metadata.

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

chunkCount

chunkCount: number

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

Number of chunks.


clauseCount

clauseCount: number

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

Number of extracted clauses.


createdAt?

optional createdAt: string | null

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

Creation timestamp (RFC 3339), when a registry row exists.


entityCount

entityCount: number

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

Number of linked entities.


id

id: string

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

Document id.


keyPoints

keyPoints: string[]

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

LLM-generated key points.


name

name: string

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

Display name.


qaPairs

qaPairs: DocumentQaPair[]

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

Generated Q&A pairs (document.qa terms).


status

status: string

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

Lifecycle status — one of DocumentStatus, or "unknown".


summary?

optional summary: string | null

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

LLM-generated summary (null when enrichment didn’t run).