stt dictionaries

Publish a dictionary

The catalog is the stt_cli/dictionaries/ directory of the stt-cli repository. Publishing is a pull request: no account here, no database, and the same review every stt change gets. When it merges, stt bundles your dictionary and this site redeploys from the same commit, so both serve the same bytes.

  1. Write the file. Add stt_cli/dictionaries/<id>.json — copy accounting-tax.json as a starting point. The id is a lowercase slug and equals the file name. Pick exactly one topic tag and any facets from tags.json.
  2. Only real mis-hearings. Each aka is a wrong spelling a speech model actually produces, never an ordinary word — aliases are replaced without asking. Say in source how you found them.
  3. Regenerate the index. This validates every file exactly as stt dict add would and rewrites the index with your file's hash:
    python -m stt_cli.catalog
  4. Open a pull request with both files. CI re-runs the validation and checks the committed index byte for byte; a maintainer reviews the terms and notes.
  5. Merged. The site redeploys and your dictionary appears here at /d/<id>, installable with stt dict install <id>.

Format

The full contract — fields, limits, id rules — is section 3 of docs/specs/dictionaries.md.

API

GET /api/dictionaries?tag=<tag>&q=<query> returns the catalog index (with no parameters, byte-identical to the committed index.json); GET /api/dictionaries/<id> returns a dictionary file's bytes, whose SHA-256 matches its index entry.