63 lines
2.6 KiB
Markdown
63 lines
2.6 KiB
Markdown
# 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.26.0 or newer:
|
|
|
|
```sh
|
|
go build -o ./bin/audita ./cmd/audita
|
|
```
|
|
|
|
Processing requires a reachable [compatible LLM endpoint](docs/integrations/openai-compatible-llm.md)
|
|
and access to a model you select. The [minimal config](examples/minimal-config.yml)
|
|
targets an unauthenticated local endpoint; edit its endpoint and
|
|
[local profiles](examples/profiles/local/) to match your service and models. The
|
|
[service example](examples/production-config.yml) demonstrates a named credential
|
|
reference and a shared backend. Set its referenced environment variable before
|
|
validating it. The [testing overlay](examples/overlays/testing.yml) selects both
|
|
role profiles, but model cost, speed, and quality depend on your provider choices.
|
|
|
|
Check configuration and profile selection offline:
|
|
|
|
```sh
|
|
./bin/audita config validate --config examples/minimal-config.yml
|
|
./bin/audita config print-effective --config examples/minimal-config.yml --view profiles
|
|
```
|
|
|
|
Run the included small input with the minimal config:
|
|
|
|
```sh
|
|
./bin/audita process examples/tiny-transcript.json \
|
|
--config examples/minimal-config.yml \
|
|
--glossary examples/tiny-glossary.yaml \
|
|
--output corrected.json
|
|
```
|
|
|
|
This makes LLM requests. Explicit setting flags override the selected file and
|
|
optional overlay; general environment setting overrides are no longer read.
|
|
By default the command writes `errors.yml`, `recoveries.yml`, and `report.md`
|
|
beside `corrected.json`. Use `--reporting=false` to suppress those files, or
|
|
`--debug` to retain detailed run artifacts under the configured debug work
|
|
directory. Model failures affecting some operations can still yield a completed
|
|
transcript with applied corrections; the summary and reports identify them.
|
|
See the [v2 migration guide](docs/migrations/v2.md) for old configurations.
|
|
|
|
## Documentation
|
|
|
|
- [CLI reference](docs/cli.md)
|
|
- [Configuration and maintained examples](docs/config.md)
|
|
- [Operations and artifact lifecycle](docs/operations.md)
|
|
- [Transcript and glossary inputs](docs/integrations/transcript-glossary-files.md)
|
|
- [Output files and report formats](docs/integrations/output-files.md)
|
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
|
- [LLM endpoint contract](docs/integrations/openai-compatible-llm.md)
|
|
- [Contributor guide](docs/development.md)
|
|
|
|
Audita is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
|
|
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|