Semantiva Documentation

Semantiva is a semantic execution framework for typed, traceable, inspectable pipelines.

This documentation is organised by role and experience level. The main sections are:

• Getting started - a short onboarding path to the core ideas.

• Persona entry points - recommended journeys for different types of users.

• User guide - day-to-day pipeline work and CLI usage.

• Tracing, identity & inspection - provenance, SER traces and debugging tools.

• Component authoring & architecture - how to extend, embed and structure Semantiva.

• Tutorials - step-by-step walkthroughs of common workflows.

• Reference - exception types, glossary entries and low-level API details.

Where to start

• New to Semantiva? Start with Getting Started, then see Pipeline users.

• Writing or maintaining processors? See Framework developers & component authors.

• Integrating Semantiva into a wider system? See Architects & system designers.

Pipelines can be defined declaratively in YAML and run via the semantiva CLI (see Pipelines - YAML & CLI), which is the canonical and supported path for production. Framework developers can also construct and run pipelines directly in Python for development and R&D workflows (see Pipelines in Python).

Getting started

• Getting Started

Persona entry points

• Pipeline users
• Framework developers & component authors
• Architects & system designers

User guide

• Basic Concepts
• Data Types
• Data Operations
• Data Probes
• Data I/O: sources and sinks
• Context Type
• Pipelines - YAML & CLI
• Pipelines in Python
• Pipelines in Semantiva
• Data collections
• Collection-based modifiers
• Utility Components
• Run Space (v1): blocks that expand context
• Context Processors
• Semantiva CLI

Tracing, identity & inspection

• Semantic Execution Record (SER) v1
• SER v1 JSON Schema
• Trace Stream v1
• Trace Aggregator v1
• Trace ↔ Graph Alignment
• Identity Cheatsheet
• Canonical Graph Builder
• Inspection Payload & CLI
• Introspection & Validation
• Run-Space Emission (Runtime)
• Run-Space Lifecycle
• Execution

Component authoring & architecture

• Creating Components (Authoring Guide)
• Architecture overview
• Extending Semantiva (Registries & Extensions)
• Workflows — Fitting Models via model:
• Context Processing Architecture
• Pipeline Configuration Schema
• Registry System
• Semantiva Studio Viewer

Tutorials

• Run Space Quickstart (Local)

Reference

• Semantiva Contracts
• API Reference
• Logger
• Exceptions
• Glossary
• Examples Index
• Testing Strategies and Best Practices

Index & search

• Index — Global index of terms and pages

• Module Index — Python module index

• Search Page — Full-text search