Update the seeded default compression combo to use the RTK then Caveman pipeline in both fresh installs and upgraded databases. Add a targeted migration and runtime guard that only rewrites the legacy seeded record when its original metadata and single-step pipeline still match, preserving user-customized default combos. Refresh docs and tests to reflect the stacked default and expanded RTK filter catalog.
2.8 KiB
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, Japanese, and future language packs to evolve independently.
Location
Language packs live under:
open-sse/services/compression/rules/<language>/
Current shipped packs include:
| Language | Directory |
|---|---|
| English | rules/en/ |
| Portuguese (Brazil) | rules/pt-BR/ |
| Spanish | rules/es/ |
| German | rules/de/ |
| French | rules/fr/ |
| Japanese | rules/ja/ |
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:
{
"languageConfig": {
"enabled": true,
"defaultLanguage": "en",
"autoDetect": true,
"enabledPacks": ["en", "pt-BR", "es", "de", "fr", "ja"]
},
"cavemanConfig": {
"language": "en",
"autoDetectLanguage": true,
"enabledLanguagePacks": ["en", "pt-BR", "es", "de", "fr", "ja"]
}
}
languageConfig controls dashboard/preview defaults. cavemanConfig is the runtime engine config
used when Caveman compresses message text.
Adding a Language Pack
- Create
open-sse/services/compression/rules/<language>/<pack>.json. - Use the Caveman rule format from
docs/COMPRESSION_RULES_FORMAT.md. - Keep replacements conservative and avoid changing code, identifiers, URLs, or JSON.
- Add or update tests for language selection and replacement behavior.
- Expose new dashboard/i18n labels if the language appears in UI selectors.
API
Available packs can be queried with:
curl http://localhost:20128/api/compression/language-packs
The preview endpoint accepts language config overrides:
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
}
}
}'
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.