49 lines
1.6 KiB
Plaintext
49 lines
1.6 KiB
Plaintext
LanguageTool Template
|
|
=====================
|
|
|
|
LanguageTool is an open-source proofreading software for English, French, German,
|
|
Polish, Russian, and more than 20 other languages. It finds many errors that a
|
|
simple spell checker cannot detect.
|
|
|
|
This template uses the erikvl87/languagetool Docker image which includes:
|
|
- FastText language detection (preinstalled)
|
|
- Support for n-gram datasets for improved error detection
|
|
- Configurable Java heap settings
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
Edit config/service.env to customize:
|
|
|
|
CONTAINER_NAME - Name of the Docker container
|
|
HTTP_PORT - Port to expose LanguageTool API (default: 8010)
|
|
JAVA_XMS - Minimum Java heap size (default: 256m)
|
|
JAVA_XMX - Maximum Java heap size (default: 512m)
|
|
ENABLE_NGRAMS - Enable n-gram data volume (default: false)
|
|
LANGTOOL_PIPELINEPREWARMING - Prewarm pipeline for faster first request
|
|
|
|
N-GRAM DATA (OPTIONAL)
|
|
----------------------
|
|
For improved error detection, you can download n-gram data:
|
|
https://languagetool.org/download/ngram-data/
|
|
|
|
1. Set ENABLE_NGRAMS=true in service.env
|
|
2. Copy n-gram files to the data volume
|
|
3. Reinstall the service
|
|
|
|
API USAGE
|
|
---------
|
|
Check text:
|
|
curl --data "language=en-US&text=a simple test" http://localhost:8010/v2/check
|
|
|
|
Check with auto-detected language:
|
|
curl --data "text=a simple test" http://localhost:8010/v2/check
|
|
|
|
List supported languages:
|
|
curl http://localhost:8010/v2/languages
|
|
|
|
RESOURCES
|
|
---------
|
|
- Docker image: https://github.com/Erikvl87/docker-languagetool
|
|
- LanguageTool: https://languagetool.org/
|
|
- API docs: https://languagetool.org/http-api/
|