Skip to content

API Reference Overview

Welcome to the scinr.newton API reference. All API documentation is auto-generated from Python docstrings using mkdocstrings.

Core Modules

  • Pipeline: run_pipeline() orchestrator.
  • Progress: live progress of run_pipeline() — ProgressEvent (one per stage boundary of each document), the ProgressCallback / AsyncProgressCallback base classes, and the built-in ProgressTracker with snapshot().
  • Configuration: configure(), get_config(), ScinrConfig.
  • Stages: Individual stage runner functions (Stages 0-5).
  • Normalization: NormalizationEngine and normalization utilities.
  • Results: PipelineResult, StageResult, DocumentResult, DeletionResult, OrphanCollectionResult, FreezeResult, RestoreResult.
  • Exceptions: ScinrError hierarchy.
  • Deletion: delete_document() — permanent document removal with cascade and garbage collection, always scoped to one tenant (tenant_id is mandatory; None / "__public__" = public documents); collect_orphans() — maintenance sweep of every orphaned extraction node of a tenant.
  • Freezing: freeze_document(), restore_document(), export_document_snapshot() — archive a document's subtree to a snapshot, reduce it to a stub and rebuild it later; same tenant-scoped selector as delete_document().
  • Converters: Document format converters.
  • Storage: Storage backends.
  • Navigation: Read-only, engine-abstracted graph traversal — documents, structure nodes, model instances, entities.
  • Utilities: Theme registry, LLM factory, and utilities.

User Guides

For tutorials and how-to guides, see the User Guides section.