audita/README.md

Audita

Audita polishes transcript JSON using glossary-aware and LLM-backed correction modules. It validates proposed corrections and produces corrected text plus reports for review and subprocess integration.

Quickstart

From a checkout, build with Go 1.24 or newer:

go build -o ./bin/audita ./cmd/audita

Processing requires a reachable compatible LLM endpoint and access to its configured model. Supply its credentials through the configuration mechanisms; the minimal config reads AUDITA_LLM_API_KEY and uses the default model and endpoint. Set that variable in your environment before using an endpoint that requires authentication. For another endpoint or model, edit a copy of the config.

Run the included small input with the minimal config:

./bin/audita process examples/tiny-transcript.json \
  --config examples/minimal-config.yml \
  --glossary examples/tiny-glossary.yaml \
  --output corrected.json

This makes LLM requests. Inherited configuration environment overrides still apply; see precedence.

Documentation

• CLI reference
• Configuration and maintained examples
• Operations and artifact lifecycle
• Transcript and glossary inputs
• Output files and report formats
• Subprocess integration
• LLM endpoint contract
• Contributor guide