OSII turns local files into grounded, inspectable information that people can browse, search, enrich, and use through AI agents. Start with the path that matches what you want to do.
- Read the repository README included with your checkout for the first-run path.
- Run the corporate pilot bundle
- Follow the friendly Python walkthrough
- Process one file through the CLI
These three pages are the normal entry points. The remaining documentation is reference material: read it when you need to understand, extend, or operate a specific boundary rather than from top to bottom.
After starting OSII, the dashboard's Setup page is the single place to connect AI, start optional Tika or Tesseract capabilities, review processing defaults, and reach advanced processor diagnostics.
- Architecture and component boundaries
- Extraction architecture
- Synthesis architecture
- OSII store structure
New processor authors should begin here.
- Choose a processor kind.
- Build the hello table enricher.
- Follow the processor development rules.
- Implement the Processor API v1 contract.
- Return a standard dashboard and agent artifact.
OSII extension services are ordinary Python HTTP containers. A subject-matter expert owns the domain logic; the OSII SDK supplies validated request and response models plus the FastAPI endpoints.
Core commit adapters validate remote extraction, synthesis, embedding, and
enrichment responses. Processor services return typed results and never write
the .osii store directly.
- Local and intermittently connected operation
- Guaranteed container-free processor services
- Extractor routing
- Export components for separate repositories
- Publish the consolidated images to Quay
- Sensitive data, OSII package transfer, and deletion
- REST API overview
- API resource model
- Search semantics
- Keyword suggestions and example enrichments
- API compatibility
- Processor API v1
- Model-provider capabilities
- Catalog and flat-file browsing
- Collection file format
- CLI cheat sheet
- Contributor guide
- Run
mkdocs serveafter installingdocs/requirements.txtto preview these pages locally.