Interface: DocumentProgressDto
@kortexya/reasoninglayer / DocumentProgressDto
Interface: DocumentProgressDto
Section titled “Interface: DocumentProgressDto”Defined in: src/types/ingestion.ts:74
Live progress snapshot for a single document being ingested.
Remarks
Section titled “Remarks”Returned by GET /api/v1/ingest/sessions/{session_id}/progress.
Provides real-time counters and pipeline step information.
Properties
Section titled “Properties”chunksFailed
Section titled “chunksFailed”chunksFailed:
number
Defined in: src/types/ingestion.ts:76
Number of chunks that failed.
chunksProcessed
Section titled “chunksProcessed”chunksProcessed:
number
Defined in: src/types/ingestion.ts:78
Number of chunks fully processed.
currentChunk
Section titled “currentChunk”currentChunk:
number
Defined in: src/types/ingestion.ts:80
Current chunk index (0-based).
currentChunkPreview?
Section titled “currentChunkPreview?”
optionalcurrentChunkPreview?:string|null
Defined in: src/types/ingestion.ts:82
Preview of the chunk currently being processed.
currentStep
Section titled “currentStep”currentStep:
string
Defined in: src/types/ingestion.ts:84
Current pipeline step (e.g., “chunking”, “llm_extraction”, “sort_reconciliation”).
currentStepLabel
Section titled “currentStepLabel”currentStepLabel:
string
Defined in: src/types/ingestion.ts:86
Human-readable label for the current step.
discoveredEntityTypes?
Section titled “discoveredEntityTypes?”
optionaldiscoveredEntityTypes?:string[]
Defined in: src/types/ingestion.ts:88
Entity types discovered during schema discovery.
discoveredRelationTypes?
Section titled “discoveredRelationTypes?”
optionaldiscoveredRelationTypes?:string[]
Defined in: src/types/ingestion.ts:90
Relation types discovered during schema discovery.
documentId
Section titled “documentId”documentId:
string
Defined in: src/types/ingestion.ts:92
Document ID (UUID).
domainSummary?
Section titled “domainSummary?”
optionaldomainSummary?:string|null
Defined in: src/types/ingestion.ts:94
Domain summary from schema discovery.
elapsedSeconds
Section titled “elapsedSeconds”elapsedSeconds:
number
Defined in: src/types/ingestion.ts:96
Elapsed seconds since start.
entitiesCreated
Section titled “entitiesCreated”entitiesCreated:
number
Defined in: src/types/ingestion.ts:98
New entities created.
entitiesExtracted
Section titled “entitiesExtracted”entitiesExtracted:
number
Defined in: src/types/ingestion.ts:100
Entities extracted so far.
entitiesFiltered
Section titled “entitiesFiltered”entitiesFiltered:
number
Defined in: src/types/ingestion.ts:102
Entities filtered out by validation.
entitiesMerged
Section titled “entitiesMerged”entitiesMerged:
number
Defined in: src/types/ingestion.ts:104
Entities merged via deduplication.
entitiesPendingReview
Section titled “entitiesPendingReview”entitiesPendingReview:
number
Defined in: src/types/ingestion.ts:106
Entities pending review.
estimatedCostUsd?
Section titled “estimatedCostUsd?”
optionalestimatedCostUsd?:number|null
Defined in: src/types/ingestion.ts:108
Estimated USD cost.
extractionStrategy
Section titled “extractionStrategy”extractionStrategy:
string
Defined in: src/types/ingestion.ts:110
Extraction strategy (“llm”, “local_ner”, “hybrid”, “schema_guided”, “adaptive”).
inferenceRulesApplied
Section titled “inferenceRulesApplied”inferenceRulesApplied:
number
Defined in: src/types/ingestion.ts:112
Inference rules applied.
modelName?
Section titled “modelName?”
optionalmodelName?:string|null
Defined in: src/types/ingestion.ts:114
LLM model name (if applicable).
referencesResolved
Section titled “referencesResolved”referencesResolved:
number
Defined in: src/types/ingestion.ts:120
References resolved.
referencesUnresolved
Section titled “referencesUnresolved”referencesUnresolved:
number
Defined in: src/types/ingestion.ts:122
Unresolved references.
relationsExtracted
Section titled “relationsExtracted”relationsExtracted:
number
Defined in: src/types/ingestion.ts:124
Relations extracted so far.
relationsFromInference
Section titled “relationsFromInference”relationsFromInference:
number
Defined in: src/types/ingestion.ts:126
Relations from inference rules.
relationsIntegrated
Section titled “relationsIntegrated”relationsIntegrated:
number
Defined in: src/types/ingestion.ts:128
Relations integrated as OSF features.
residuationsCreated
Section titled “residuationsCreated”residuationsCreated:
number
Defined in: src/types/ingestion.ts:116
Residuations created (suspended operations).
residuationsResumed
Section titled “residuationsResumed”residuationsResumed:
number
Defined in: src/types/ingestion.ts:118
Residuations resumed.
reviewsPersisted
Section titled “reviewsPersisted”reviewsPersisted:
number
Defined in: src/types/ingestion.ts:130
Reviews persisted.
sortNames?
Section titled “sortNames?”
optionalsortNames?:string[]
Defined in: src/types/ingestion.ts:132
Sort names created or reused.
sortsCreated
Section titled “sortsCreated”sortsCreated:
number
Defined in: src/types/ingestion.ts:134
New sorts created.
sortsReused
Section titled “sortsReused”sortsReused:
number
Defined in: src/types/ingestion.ts:136
Existing sorts reused (exact match).
sortsReusedSemantic
Section titled “sortsReusedSemantic”sortsReusedSemantic:
number
Defined in: src/types/ingestion.ts:138
Sorts reused via semantic matching.
startedAt
Section titled “startedAt”startedAt:
string
Defined in: src/types/ingestion.ts:140
When ingestion started (ISO 8601).
stepLog
Section titled “stepLog”stepLog:
StepLogEntryDto[]
Defined in: src/types/ingestion.ts:142
Chronological log of pipeline events.
tokensInput
Section titled “tokensInput”tokensInput:
number
Defined in: src/types/ingestion.ts:144
Total input tokens consumed.
tokensOutput
Section titled “tokensOutput”tokensOutput:
number
Defined in: src/types/ingestion.ts:146
Total output tokens consumed.
totalChunks
Section titled “totalChunks”totalChunks:
number
Defined in: src/types/ingestion.ts:148
Total number of chunks in the document.
updatedAt
Section titled “updatedAt”updatedAt:
string
Defined in: src/types/ingestion.ts:150
Last progress update (ISO 8601).