Skip to main content

Module envelope

Module envelope 

Source
Expand description

Top-level JSON envelope for --format=json output (§7).

The envelope is a stable shape for any combination of axes, strategies, and depths. Envelope is the outer object; ResultBlock / DetectionReport / Page / InputFormat are its components.

Structs§

DetectionReport
Provenance for auto-detection decisions (§4.6).
Envelope
Top-level envelope (§7).
EnvelopeCache
Optional source records stored in a JSON envelope so face can re-drill and re-cluster without re-running the upstream command.
Page
Page block — populated when --cluster is set (§7.2).
ResultBlock
Result-level metadata block within the envelope.

Enums§

InputFormat
Detected or supplied input format.