Complete Phase 14 homophones module
This commit is contained in:
@@ -35,12 +35,13 @@ Implemented today:
|
||||
- Production module registry scaffolding with known-key recognition and explicit unsupported/unimplemented errors.
|
||||
- Production `grammar` module implementation in `internal/modules/grammar`.
|
||||
- Production `glossary` module implementation in `internal/modules/glossary`.
|
||||
- Production `homophones` module implementation in `internal/modules/homophones`.
|
||||
- Explicit runtime support for `--modules grammar` through the production runner path.
|
||||
- Explicit runtime support for `--modules glossary`, including repeated stages such as `--modules glossary,glossary`.
|
||||
- Explicit runtime support for `--modules homophones` through the production runner path.
|
||||
|
||||
Not implemented in CLI runtime path today:
|
||||
- Real module execution pipeline for `homophones` and `spoken_word`.
|
||||
- Real domain proposal prompts for remaining production modules.
|
||||
- Real module execution pipeline for `spoken_word`.
|
||||
- End-to-end transcript polishing with the full default module sequence.
|
||||
|
||||
Phase sequencing note:
|
||||
@@ -49,7 +50,8 @@ Phase sequencing note:
|
||||
- Phase 11 shared proposal-generation framework and module-registry scaffolding are complete;
|
||||
- Phase 12 grammar module implementation and explicit runtime wiring are complete;
|
||||
- Phase 13 glossary module and protected-term behavior are complete;
|
||||
- next recommended phase is Phase 14 (homophones module).
|
||||
- Phase 14 homophones module implementation and explicit runtime wiring are complete;
|
||||
- next recommended phase is Phase 15 (spoken-word module).
|
||||
|
||||
## Actual Go package layout
|
||||
|
||||
@@ -116,6 +118,10 @@ internal/modules/glossary/
|
||||
module.go
|
||||
prompt.go
|
||||
|
||||
internal/modules/homophones/
|
||||
module.go
|
||||
prompt.go
|
||||
|
||||
internal/framework/validators/
|
||||
models.go
|
||||
deterministic.go
|
||||
@@ -151,17 +157,17 @@ Current runtime flow (`internal/cli/run.go`):
|
||||
10. Chunk normalized transcript and compute chunk summaries.
|
||||
11. Write chunking summary artifact.
|
||||
12. Execute runner modules sequentially when:
|
||||
- `--modules` is explicitly provided (production grammar/glossary paths); or
|
||||
- `--modules` is explicitly provided (production grammar/glossary/homophones paths); or
|
||||
- a test/injected module factory is provided.
|
||||
13. Output working transcript to `--output` file or stdout.
|
||||
14. Build process report (`phase` currently set to `phase13-glossary-module`).
|
||||
14. Build process report (`phase` currently set to `phase14-homophones-module`).
|
||||
15. Optionally write `--report-json`; always write run-dir `report.json`.
|
||||
16. Apply work-dir retention.
|
||||
|
||||
Important behavior details:
|
||||
- Glossary is validated and is used for explicit glossary/grammar module correction paths.
|
||||
- Glossary is validated and is used for explicit glossary/grammar/homophones module correction paths.
|
||||
- Default production CLI behavior remains deterministic normalization/chunking/reporting unless modules are explicitly selected with `--modules`.
|
||||
- Explicit `--modules grammar` and `--modules glossary` run production module paths with LLM-backed proposal generation and validator-chain execution.
|
||||
- Explicit `--modules grammar`, `--modules glossary`, and `--modules homophones` run production module paths with LLM-backed proposal generation and validator-chain execution.
|
||||
- Default runs (without explicit module selection) do not perform LLM calls.
|
||||
- Success path is generally quiet on stderr.
|
||||
- Source IDs are preserved into a canonical transcript before normalization; normalization then reassigns output IDs sequentially from `1`.
|
||||
@@ -210,7 +216,7 @@ Implemented config surfaces include:
|
||||
- work-dir and retention mode
|
||||
|
||||
Current caveat:
|
||||
- LLM/module-related settings are active for explicit grammar/glossary runs; the default non-explicit path remains deterministic.
|
||||
- LLM/module-related settings are active for explicit grammar/glossary/homophones runs; the default non-explicit path remains deterministic.
|
||||
|
||||
## Implemented structured LLM infrastructure
|
||||
`internal/framework/contracts` now defines a typed structured-completion contract:
|
||||
@@ -227,7 +233,7 @@ Current caveat:
|
||||
|
||||
Current runtime boundary:
|
||||
- the default CLI runtime path (without explicit module selection) still does not instantiate the full production module sequence.
|
||||
- LLM calls are exercised in production when `--modules grammar` or `--modules glossary` is explicitly requested and in tests when fake/injected clients are used.
|
||||
- LLM calls are exercised in production when `--modules grammar`, `--modules glossary`, or `--modules homophones` is explicitly requested and in tests when fake/injected clients are used.
|
||||
|
||||
`internal/framework/llm` also provides:
|
||||
- a bounded `Scheduler` for controlled concurrent LLM calls with reliable permit release;
|
||||
@@ -334,7 +340,7 @@ This helper only produces candidate proposals; validator-chain execution and pro
|
||||
- diagnostics directory context
|
||||
- returns explicit errors for unknown keys (`unsupported_module`) and recognized-but-unimplemented keys (`unimplemented_module`).
|
||||
|
||||
The `grammar` and `glossary` module keys are now registered and constructible. `homophones` and `spoken_word` remain recognized-but-unimplemented.
|
||||
The `grammar`, `glossary`, and `homophones` module keys are now registered and constructible. `spoken_word` remains recognized-but-unimplemented.
|
||||
|
||||
## Implemented grammar production module
|
||||
`internal/modules/grammar` now provides the first production module:
|
||||
@@ -368,6 +374,19 @@ The `grammar` and `glossary` module keys are now registered and constructible. `
|
||||
|
||||
This vocabulary is used by deterministic validators for both glossary-stage and non-glossary-stage protection checks, keeping protected-term guardrails active across modules.
|
||||
|
||||
## Implemented homophones production module
|
||||
`internal/modules/homophones` now provides the third production module:
|
||||
- prompt builder aligned to Python homophones-module intent, constrained to conservative homophone/near-homophone/mistranscription corrections;
|
||||
- prompt context includes protected glossary names/aliases/plurals to avoid damaging known terms;
|
||||
- explicit guardrails against punctuation cleanup, grammar cleanup, style rewriting, summarization, and content invention;
|
||||
- proposal generation through `internal/framework/proposal_generation` and `contracts.StructuredLLMClient`;
|
||||
- scheduler-aware proposal calls through existing `contracts.LLMScheduler` hooks;
|
||||
- replacement policy `require_unique` (matching Python homophones behavior);
|
||||
- validator chain integration using existing deterministic + LLM-backed validators;
|
||||
- homophones confidence threshold enforcement through existing validator/config infrastructure;
|
||||
- protected-term guardrails for non-glossary modules remain active and are exercised through the homophones path;
|
||||
- module-level reporting and diagnostics capture through existing runner/reporting paths.
|
||||
|
||||
## Reports and diagnostics (implemented)
|
||||
Current per-run artifacts include:
|
||||
- `source-transcript.json`
|
||||
@@ -407,7 +426,7 @@ Retention modes implemented in `ApplyRetention`:
|
||||
|
||||
Current runtime note:
|
||||
- default non-explicit runs usually have no module-level skipped corrections, so `auto` commonly removes clean successful run directories.
|
||||
- explicit grammar/glossary runs can produce validator rejections and application skips, which are reflected in reports and retention input.
|
||||
- explicit grammar/glossary/homophones runs can produce validator rejections and application skips, which are reflected in reports and retention input.
|
||||
|
||||
Intentionally deferred to module/LLM phases:
|
||||
- real domain proposal prompts and production module implementations remain tied to later module phases.
|
||||
@@ -430,14 +449,15 @@ Implemented tests currently cover:
|
||||
- production module-registry known-key recognition and unsupported/unimplemented error behavior (`internal/framework/modules/*_test.go`, `internal/cli/run_test.go`)
|
||||
- production grammar module prompt constraints, proposal mapping, validator-chain behavior, confidence-threshold enforcement, diagnostics redaction, and explicit CLI/runtime integration (`internal/modules/grammar/*_test.go`, `internal/cli/run_test.go`, `internal/framework/runner/*_test.go`)
|
||||
- production glossary module prompt constraints, proposal mapping, validator-chain behavior, confidence-threshold enforcement, diagnostics redaction, repeated-stage behavior, and explicit CLI/runtime integration (`internal/modules/glossary/*_test.go`, `internal/cli/run_test.go`, `internal/framework/runner/*_test.go`)
|
||||
- production homophones module prompt constraints, proposal mapping, validator-chain behavior, confidence-threshold enforcement, diagnostics redaction, protected-term behavior, and explicit CLI/runtime integration (`internal/modules/homophones/*_test.go`, `internal/cli/run_test.go`, `internal/framework/runner/*_test.go`)
|
||||
- glossary-derived protected-term extraction and stable behavior (`internal/framework/validators/protected_terms_test.go`)
|
||||
|
||||
Not covered yet (because not implemented): production `homophones` and `spoken_word` modules plus full default-sequence transcript-polishing runtime behavior.
|
||||
Not covered yet (because not implemented): production `spoken_word` module plus full default-sequence transcript-polishing runtime behavior.
|
||||
|
||||
## Intended final architecture (not yet implemented)
|
||||
The intended end-state still matches the rewrite plan:
|
||||
- sequential module pipeline over a mutable working transcript
|
||||
- real module implementations (`homophones`, `spoken_word`)
|
||||
- real module implementation (`spoken_word`)
|
||||
- structured LLM proposal generation
|
||||
- deterministic and LLM validators
|
||||
- validator cardinality enforcement in pipeline execution
|
||||
|
||||
@@ -65,6 +65,9 @@ Implemented:
|
||||
- Glossary-derived deterministic protected-term extraction and validator integration.
|
||||
- Explicit `--modules glossary` runtime path through runner, shared proposal generation, validators, application, reporting, and diagnostics.
|
||||
- Repeated glossary stage support with deterministic instance names (`glossary_1`, `glossary_2`), including mutable working-transcript handoff.
|
||||
- Production homophones module package with Python-aligned prompt intent and guardrails.
|
||||
- Explicit `--modules homophones` runtime path through runner, shared proposal generation, validators, application, reporting, and diagnostics.
|
||||
- Focused multi-module runtime tests for already-implemented interoperability (for example `glossary,homophones`) without claiming full default-pipeline completion.
|
||||
- Broad deterministic and CLI/subprocess test coverage for implemented phases through `go test ./...`.
|
||||
- Internal typed structured LLM contract (`StructuredLLMClient.CompleteStructured(ctx, req, out)`).
|
||||
- `internal/framework/llm` instructor-go-backed adapter with:
|
||||
@@ -80,8 +83,8 @@ Implemented:
|
||||
- Generic JSON diagnostics primitives for LLM interactions (request metadata, request payload, response payload, optional error payload) with secret redaction.
|
||||
|
||||
Not yet implemented in runtime pipeline:
|
||||
- Real correction modules for `homophones` and `spoken_word`.
|
||||
- Domain proposal prompts for remaining real modules.
|
||||
- Real correction module for `spoken_word`.
|
||||
- Domain proposal prompts for remaining real module.
|
||||
- End-to-end transcript polishing behavior with the full default module sequence.
|
||||
|
||||
## Completed phases
|
||||
@@ -220,7 +223,7 @@ Not implemented in Phase 8 (by design):
|
||||
|
||||
## Remaining work plan
|
||||
|
||||
Next recommended phase: **Phase 14 (homophones module)**.
|
||||
Next recommended phase: **Phase 15 (spoken-word module)**.
|
||||
|
||||
## Phase 9: Structured LLM client and scheduler infrastructure
|
||||
|
||||
@@ -391,41 +394,27 @@ Not implemented in Phase 13 (by design):
|
||||
|
||||
## Phase 14: Homophones module
|
||||
|
||||
### Purpose
|
||||
Completed.
|
||||
|
||||
Implement conservative homophone and mistranscription correction behavior.
|
||||
Implemented:
|
||||
- Production homophones module package in `internal/modules/homophones`.
|
||||
- Homophones prompt builder aligned to Python intent and constrained to conservative homophone/near-homophone/mistranscription corrections.
|
||||
- Prompt context using glossary/protected-term information (names, aliases, plurals where present) to avoid damaging known domain terms.
|
||||
- Homophones proposal generation through shared `internal/framework/proposal_generation` using `contracts.StructuredLLMClient`.
|
||||
- Scheduler-aware homophones proposal generation through existing scheduler hooks.
|
||||
- Homophones replacement policy `require_unique` (matching Python behavior).
|
||||
- Homophones validator chain using existing deterministic and LLM-backed validators.
|
||||
- Homophones confidence threshold enforcement through existing config + confidence-threshold validator behavior.
|
||||
- Protected-term guardrails remaining active for homophones via existing deterministic validators.
|
||||
- Explicit runtime support for `--modules homophones` through normalization, chunking, runner, proposal generation, validation, application, and reporting.
|
||||
- Prompt/response diagnostics artifacts for homophones proposal + validator interactions with secret redaction.
|
||||
- Module-level reports for homophones including generated proposals, validator decisions/rejections, applied changes, and application skips.
|
||||
- CLI/runtime fake-client tests for approved proposals, validator rejection, application skips, diagnostics, protected-term rejection behavior, failure/error.log behavior, and report outputs (`--report-json` and run-dir `report.json`).
|
||||
- Focused interoperability tests for already-implemented module combinations (for example `glossary,homophones`) to verify working-transcript handoff and guardrails without claiming full default-sequence parity.
|
||||
|
||||
### Scope
|
||||
|
||||
Implement:
|
||||
- `homophones` module package.
|
||||
- Homophones prompt builder ported from Python.
|
||||
- Homophones structured response model.
|
||||
- Homophones replacement policy.
|
||||
- Homophones confidence threshold handling.
|
||||
- Homophones validator chain.
|
||||
- Prompt/response diagnostics.
|
||||
- CLI support for `--modules homophones`.
|
||||
- Fake LLM tests.
|
||||
- Tests for interaction with glossary/protected terms where relevant.
|
||||
|
||||
Do not implement:
|
||||
- Spoken-word module.
|
||||
- Default full pipeline parity claim unless spoken-word is already complete.
|
||||
|
||||
### Expected behavior at end of phase
|
||||
|
||||
Running `audita process ... --modules homophones` should perform real conservative homophone/mistranscription corrections using the configured LLM endpoint.
|
||||
|
||||
### Definition of done
|
||||
|
||||
- Homophones module runs in the production runner.
|
||||
- Homophones proposals are generated through structured LLM calls.
|
||||
- Validator chain is enforced.
|
||||
- Protected-term behavior is respected where applicable.
|
||||
- Applied/skipped homophone changes appear in reports.
|
||||
- Prompt/response diagnostics are written.
|
||||
- `go test ./...` passes without requiring external LLM credentials.
|
||||
Not implemented in Phase 14 (by design):
|
||||
- Production `spoken_word` module.
|
||||
- Full default module sequence execution as a feature-complete claim.
|
||||
|
||||
## Phase 15: Spoken-word module
|
||||
|
||||
|
||||
Reference in New Issue
Block a user