Add Audita configuration contract
This commit is contained in:
18
README.md
18
README.md
@@ -23,6 +23,24 @@ Seriatim config contract in `pipeline.yml`:
|
||||
- allowed `seriatim.output_schema` values: `seriatim-minimal`, `seriatim-intermediate`, `seriatim-full`
|
||||
- optional tuning: `seriatim.env.*` (`overlap_word_run_gap`, `overlap_word_run_reorder_window`, `backchannel_max_duration`, `filler_max_duration`) must be `> 0` when provided
|
||||
|
||||
Audita config contract in `pipeline.yml`:
|
||||
|
||||
- required: `audita.binary` (name or path; existence is checked at execution time, not config validation time)
|
||||
- required: `audita.llm_api_key_env` (environment variable name holding the API key secret)
|
||||
- defaulted when omitted: `audita.timeout` (`3h`), `audita.llm_api_key_env` (`AUDITA_LLM_API_KEY`), `audita.modules` (`glossary,homophones,glossary,spoken_word,grammar,homophones,glossary`), `audita.base_url` (`https://openrouter.ai/api/v1`), `audita.model` (`openrouter/google/gemma-4-31b-it`), `audita.llm_concurrency` (`1`), `audita.validation_model` (`""`), `audita.validation_llm_concurrency` (`1`), `audita.report` (`true`)
|
||||
- allowed `audita.modules` values: `glossary`, `homophones`, `spoken_word`, `grammar` (order and repeats are allowed)
|
||||
- `audita.base_url` must be a valid URL when provided
|
||||
- `audita.llm_concurrency` and `audita.validation_llm_concurrency` must be `> 0`
|
||||
|
||||
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:
|
||||
|
||||
- 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.
|
||||
|
||||
`speakers.yml` note:
|
||||
|
||||
- use Seriatim’s documented `match:` format (not the legacy direct mapping style used by older scripts/scaffolds)
|
||||
|
||||
Reference in New Issue
Block a user