Files
narratio/examples

Maintained Examples

These files are safe, copyable starting points for Narratio configuration and input structure. Replace placeholder identifiers, storage names, integration URLs, and paths for the target environment. Field meanings and defaults belong in the configuration reference.

Pipeline Configuration

  • Minimal pipeline: campaign discovery plus the required WhisperX URL.

  • Production-shaped pipeline: S3 storage, publish, external tools, and configured Scriptorium artifacts.

  • Production-base/testing-overlay bundle: explicit conf.d imports, one ordinary artifact per artifacts/<key>.yml, one family per artifact-families/<key>.yml, and the fixed profiles/testing.yml overlay. Production values live in the base. The bundle demonstrates an input-only artifact dependency, two character families sharing the campaign party, and a testing-only disabled artifact. Inspect it offline with:

    narratio config validate --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
    narratio config show --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --profile testing
    narratio config sources --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --profile testing
    narratio config artifacts --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml --profile testing
    narratio config diff default testing --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
    

    These inspection commands load configuration and resolve explicit credential references, but do not load a session or create runtime state. This bundle is intentionally local-storage and credential-reference free so the walkthrough needs no tools or cloud services.

  • Full annotated pipeline: every implemented pipeline section with explanatory comments.

  • Extraction subset pipeline: a focused Scriptorium artifact consuming only three declared Notarius lanes.

The existing internal/config example test loads and validates each pipeline with the sample campaign and a compatible local- or S3-audio session.

Campaign And Session Configuration

Input Fixtures

The examples contain environment-variable names but no credential values. Set OBJECT_STORAGE_KEY_ID, OBJECT_STORAGE_KEY, AUDITA_LLM_API_KEY, and NOTARIUS_LLM_API_KEY to nonempty synthetic or real values before loading the examples that reference them. They use fictional campaign content and reserved example domains.

For a deployed bundle, keep credential files out of source control in a secrets/ directory beside the root pipeline.yml, one file per referenced environment-variable name, or select another directory with --secrets-dir. Static S3 credentials are optional: omit both S3 credential references to use the AWS SDK discovery chain.