Interface: IngestDocumentResponse
@kortexya/reasoninglayer / IngestDocumentResponse
Interface: IngestDocumentResponse
Section titled “Interface: IngestDocumentResponse”Defined in: src/types/ingestion.ts:1443
Response from document ingestion: the 200 (parseOnly) and 201 (inline
ingestion) body of POST /api/v1/ingest/document.
Properties
Section titled “Properties”documentId?
Section titled “documentId?”
optionaldocumentId?:string|null
Defined in: src/types/ingestion.ts:1449
Session-tracking id of the document (UUID) — the key that session
progress and stats use. For the document-registry id, read
ingestionStats.documentTermId.
error?
Section titled “error?”
optionalerror?:string|null
Defined in: src/types/ingestion.ts:1451
Error message if parsing failed.
ingestionStats
Section titled “ingestionStats”ingestionStats:
IngestionStatsDto
Defined in: src/types/ingestion.ts:1453
Markdown ingestion statistics (from the markdown pipeline).
markdown?
Section titled “markdown?”
optionalmarkdown?:string|null
Defined in: src/types/ingestion.ts:1455
Markdown the document parser produced, including OCR output.
metadata
Section titled “metadata”metadata:
ParsedDocumentMetadataDto
Defined in: src/types/ingestion.ts:1457
Document metadata.
parseStats
Section titled “parseStats”parseStats:
DocumentParseStatsDto
Defined in: src/types/ingestion.ts:1459
Document parsing statistics.
pendingReview?
Section titled “pendingReview?”
optionalpendingReview?:PendingReviewDto[]
Defined in: src/types/ingestion.ts:1461
Entities that need human review.
sessionId?
Section titled “sessionId?”
optionalsessionId?:string|null
Defined in: src/types/ingestion.ts:1463
Session ID for tracking and resumption (UUID).
success
Section titled “success”success:
boolean
Defined in: src/types/ingestion.ts:1465
Whether the entire operation was successful.