Back to Omniroute

Compression Language Packs

docs/compression/COMPRESSION_LANGUAGE_PACKS.md

3.8.496.0 KB
Original Source

Compression Language Packs

Caveman compression can load language-specific rule packs in addition to the built-in English rules. This keeps the core engine stable while allowing Portuguese, Spanish, German, French, Italian, Japanese, and future language packs to evolve independently.

Location

Language packs live under:

txt
open-sse/services/compression/rules/<language>/

Current shipped packs (verified against rules/ directory contents):

LanguageDirectoryRule categories present
Englishrules/en/context, dedup, filler, structural, ultra
Spanishrules/es/context, dedup, filler, structural, ultra
Portuguese (Brazil)rules/pt-BR/context, dedup, filler, structural, ultra
Indonesianrules/id/context, dedup, filler, structural, ultra
Italianrules/it/context, dedup, filler, structural, ultra
Germanrules/de/context, filler, structural
Frenchrules/fr/context, filler, structural
Japaneserules/ja/context, filler, structural

Parity note: en, es, pt-BR, id, and it packs have the full 5 categories; de, fr, ja ship 3 categories. The missing dedup and ultra categories silently fall back to the English built-ins. Contributions welcome to add dedup.json and ultra.json for the smaller packs.

The pt-BR pack is based on Troglodita by Lenine Júnior — a compression system designed from scratch for Brazilian Portuguese grammar (pleonasm reduction, PT-BR filler removal, technical abbreviations for the dev BR community).

The canonical category list and per-category schema live in open-sse/services/compression/rules/_schema.json (JSON Schema draft 2020-12).

Language Detection

languageDetector.ts uses lightweight heuristics to infer the language from prompt text. The configured default language is still respected, and detection can be disabled by config when exact control is required.

Detection output is used only to choose rule packs. It does not change provider routing, locale selection, or UI language.

Config Shape

Compression settings can include:

json
{
  "languageConfig": {
    "enabled": true,
    "defaultLanguage": "en",
    "autoDetect": true,
    "enabledPacks": ["en", "pt-BR", "es", "id", "de", "fr", "ja"]
  },
  "cavemanConfig": {
    "language": "en",
    "autoDetectLanguage": true,
    "enabledLanguagePacks": ["en", "pt-BR", "es", "id", "de", "fr", "ja"]
  }
}

languageConfig controls dashboard/preview defaults. cavemanConfig is the runtime engine config used when Caveman compresses message text.

Adding a Language Pack

  1. Create open-sse/services/compression/rules/<language>/<pack>.json.
  2. Use the Caveman rule format from docs/compression/COMPRESSION_RULES_FORMAT.md.
  3. Keep replacements conservative and avoid changing code, identifiers, URLs, or JSON.
  4. Add or update tests for language selection and replacement behavior.
  5. Expose new dashboard/i18n labels if the language appears in UI selectors.

API

Available packs can be queried with:

bash
curl http://localhost:20128/api/compression/language-packs

The preview endpoint accepts language config overrides:

bash
curl -X POST http://localhost:20128/api/compression/preview \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "standard",
    "text": "Por favor, eu gostaria que voce basicamente resumisse isso.",
    "config": {
      "languageConfig": {
        "defaultLanguage": "pt-BR",
        "autoDetect": true
      }
    }
  }'

SHARED_BOUNDARIES (v3.8.0)

All 6 language packs received a SHARED_BOUNDARIES clause in v3.8.0 that is applied at every Caveman intensity (LITE, FULL, ULTRA). It instructs the engine to preserve these patterns verbatim, regardless of surrounding filler removal:

Pattern typeExample
Fenced code blocks```python\n...\n```
Inline code`my_var`
URLshttps://example.com/path
File paths (absolute + relative)/etc/hosts, ./src/index.ts
Error headersError:, TypeError:, SyntaxError:
Stack trace lines at functionName (file.ts:12:3)

These patterns are populated in DEFAULT_CAVEMAN_CONFIG.preservePatterns (previously []). The constant lives in open-sse/services/compression/types.ts.

Why this matters

Without SHARED_BOUNDARIES, aggressive Caveman modes could strip content that looked like repetitive prose but was actually a code snippet, file path, or error stack. SHARED_BOUNDARIES acts as a language-agnostic safety net applied before filler rules run.

Customizing preservePatterns

Additional patterns can be added at runtime via compression settings:

json
{
  "cavemanConfig": {
    "preservePatterns": [
      "```[\\s\\S]*?```",
      "`[^`]+`",
      "https?://\\S+",
      "(?:/|\\./)[^\\s]+",
      "\\b(?:Error|TypeError|SyntaxError|RangeError):",
      "\\s+at\\s+\\S+\\s+\\(\\S+:\\d+:\\d+\\)"
    ]
  }
}

Custom patterns extend (not replace) the 6 defaults.


Operational Notes

  • English built-in rules remain the fallback when a language pack is missing.
  • Invalid built-in JSON packs fail validation so release assets do not silently degrade.
  • Rule packs are data-only and should not import code or run arbitrary logic.
  • The compression analytics layer records the selected mode and engine, not full prompt text.