Document Audita polish integration
This commit is contained in:
23
README.md
23
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
`narratio` is a Go-based orchestration application for processing D&D session audio into transcripts and downstream artifacts.
|
||||
|
||||
This repository currently contains a **working scaffold** with strict config loading, local workdir/manifest handling, resumable stage control, real WhisperX and Seriatim adapters, and real `prepare` + `transcribe` + `merge` stages.
|
||||
This repository currently contains a **working scaffold** with strict config loading, local workdir/manifest handling, resumable stage control, real WhisperX/Seriatim/Audita adapters, and real `prepare` + `transcribe` + `merge` + `polish` stages.
|
||||
|
||||
## Expected Config Files
|
||||
|
||||
@@ -37,9 +37,9 @@ Audita credentials note:
|
||||
- store only the environment variable **name** in config (`audita.llm_api_key_env`), never the API key value itself
|
||||
- API key values must not be written to pipeline config, generated configs, logs, or manifest metadata
|
||||
|
||||
Audita CLI compatibility note:
|
||||
Audita runtime note:
|
||||
|
||||
- Narratio models `audita.llm_concurrency` in config now, but real adapter wiring should verify whether Audita expects a direct CLI flag or env-based configuration for primary LLM concurrency before implementation.
|
||||
- Narratio currently passes primary LLM concurrency via `AUDITA_LLM_CONCURRENCY` subprocess environment override, not a `--llm-concurrency` flag.
|
||||
|
||||
`speakers.yml` note:
|
||||
|
||||
@@ -65,13 +65,12 @@ Implemented now:
|
||||
- strict config load + validation
|
||||
- local artifact/workdir creation and locking
|
||||
- manifest create/load/save and stage status tracking
|
||||
- stage framework with real `prepare`, `transcribe`, and `merge` stages; placeholder downstream stages
|
||||
- stage framework with real `prepare`, `transcribe`, `merge`, and `polish` stages; placeholder downstream stages
|
||||
- resumable run control (`run`, `resume`, `run-stage`, `plan` with run/skip decisions)
|
||||
- real WhisperX HTTP adapter plus real Seriatim subprocess adapter (both with fake/no-op adapters for test/scaffold usage)
|
||||
- real WhisperX HTTP adapter plus real Seriatim/Audita subprocess adapters (with fake/no-op adapters for test/scaffold usage)
|
||||
|
||||
Not implemented yet:
|
||||
|
||||
- real Audita execution
|
||||
- real analyzer integration
|
||||
- real remote archive/storage backend
|
||||
- real notification backend
|
||||
@@ -90,12 +89,22 @@ go run ./cmd/narratio plan --config examples/pipeline.minimal.yml --session exam
|
||||
|
||||
## Run Pipeline (Current State)
|
||||
|
||||
The current `run` command executes `prepare` + real `transcribe` + real `merge` + placeholder downstream stages and records progress in `manifest.json`.
|
||||
The current `run` command executes `prepare` + real `transcribe` + real `merge` + real `polish` + placeholder downstream stages and records progress in `manifest.json`.
|
||||
|
||||
Default CLI wiring builds and uses:
|
||||
|
||||
- real WhisperX HTTP adapter from `pipeline.whisperx`
|
||||
- real Seriatim subprocess adapter from `pipeline.seriatim`
|
||||
- real Audita subprocess adapter from `pipeline.audita`
|
||||
|
||||
Real `polish` stage output paths:
|
||||
|
||||
- `transcripts/processed.json`
|
||||
- `artifacts/audita.report.json` (when `audita.report: true`)
|
||||
- `artifacts/audita-work`
|
||||
- `logs/audita.stdout.log`
|
||||
- `logs/audita.stderr.log`
|
||||
- `config/audita.generated.yml`
|
||||
|
||||
```bash
|
||||
go run ./cmd/narratio run --config examples/pipeline.minimal.yml --session examples/session.minimal.yml
|
||||
|
||||
Reference in New Issue
Block a user