42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
# Audita
|
|
|
|
Audita polishes transcript JSON with glossary-aware and LLM-backed correction
|
|
modules. It validates proposed edits and produces corrected text and reports for
|
|
review or subprocess integration.
|
|
|
|
## Quickstart
|
|
|
|
Build with Go 1.27.0 or newer:
|
|
|
|
```sh
|
|
go build -o ./bin/audita ./cmd/audita
|
|
```
|
|
|
|
Edit the synthetic endpoint and model in [examples/local/prompts.yml](examples/local/prompts.yml)
|
|
for a reachable OpenAI-compatible service. From `examples/local`, run the built
|
|
executable (adjust the executable path if needed):
|
|
|
|
```sh
|
|
../../bin/audita config validate --config config.yml
|
|
../../bin/audita process --config config.yml --output corrected.json transcript.json
|
|
```
|
|
|
|
Processing makes model requests. Reports are written beside the output by default;
|
|
recoverable model errors can appear in a completed run. The [example guide](examples/README.md)
|
|
includes service, overlay, prompt editing, preview, and shared glossary projects.
|
|
See the [v3 migration guide](docs/migrations/v3.md) for the configuration cutover.
|
|
|
|
## Documentation
|
|
|
|
- [CLI reference](docs/cli.md) and [configuration](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.
|