Improve error handling and diagnostics for the audita subprocess
This commit is contained in:
11
README.md
11
README.md
@@ -26,8 +26,8 @@ Seriatim config contract in `pipeline.yml`:
|
||||
Audita config contract in `pipeline.yml`:
|
||||
|
||||
- required: `audita.binary` (name or path; existence is checked at execution time, not config validation time)
|
||||
- optional: `audita.llm_api_key_env` (environment variable name holding the API key secret; defaults to `AUDITA_LLM_API_KEY`)
|
||||
- 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`)
|
||||
- optional: `audita.llm_api_key_env` (environment variable name holding the API key secret; no automatic default)
|
||||
- defaulted when omitted: `audita.timeout` (`3h`), `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`
|
||||
@@ -36,7 +36,8 @@ 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
|
||||
- if the named env var is not set (or is empty), Narratio omits `AUDITA_LLM_API_KEY` from the Audita subprocess environment instead of failing
|
||||
- if `audita.llm_api_key_env` is configured and the named env var is not set (or is empty), Narratio fails before invocation with a redacted error
|
||||
- if `audita.llm_api_key_env` is omitted/empty, Narratio does not require a credential and omits `AUDITA_LLM_API_KEY` from the subprocess overrides
|
||||
|
||||
Audita runtime note:
|
||||
|
||||
@@ -98,6 +99,10 @@ Default CLI wiring builds and uses:
|
||||
- real Seriatim subprocess adapter from `pipeline.seriatim`
|
||||
- real Audita subprocess adapter from `pipeline.audita`
|
||||
|
||||
Subprocess runtime note:
|
||||
|
||||
- subprocesses inherit the parent environment by default, then apply Narratio override values (override values win).
|
||||
|
||||
Real `polish` stage output paths:
|
||||
|
||||
- `transcripts/processed.json`
|
||||
|
||||
Reference in New Issue
Block a user