API Reference

• Installation and quick start
  • Installation
  • Quick start
• Examples
  • Basic usage
    • Checking text for errors
    • Correcting text automatically
    • Applying a specific suggestion
  • Using the public API (no local server)
  • Checking only specific regions of text
  • Controlling rules
    • Disabling specific rules
    • Enabling only specific rules
    • Controlling categories
    • Picky mode (stricter checking)
    • Preferred language variants
  • Mother tongue detection
  • Classifying matches
  • Custom spellings
  • Using a remote LanguageTool server
  • Inspecting a Match object
• Advanced usage
  • Pinning the LanguageTool version
  • Authenticating with a premium API key
  • Client/server pattern
  • Resource management
  • Error handling
• Local server configuration
  • Quick example
  • Accepted keys
    • Limits
    • Rate limiting
    • Pipeline caching
    • External models
    • Access control
    • Miscellaneous
  • Language-specific keys
  • API reference
• Command-line interface
  • Usage
  • Options
  • Exit codes
  • Examples
• Environment variables
  • Download and cache
  • Integrity verification
  • Safe ZIP extraction limits
  • Example
• language_tool_python package (full API reference)
  • Available modules
    • Core - language_tool_python.server
      • LanguageTool
      • LanguageToolPublicAPI
    • Match - language_tool_python.match
      • Match
      • is_check_match()
    • Utilities - language_tool_python.utils
      • TextStatus
      • classify_matches()
      • correct()
    • Exceptions - language_tool_python.exceptions
      • JavaError
      • LanguageToolError
      • PathError
      • RateLimitError
      • ServerError
    • Language tags - language_tool_python.language_tag
      • LanguageTag
    • Server configuration - language_tool_python.config_file
      • ConfigValue
      • LanguageToolConfig
  • Advanced
    • Download management - language_tool_python.download_lt
      • LTP_DOWNLOAD_VERSION
      • LocalLanguageTool
      • ReleaseLocalLanguageTool
      • SnapshotLocalLanguageTool
    • Internal utilities - language_tool_python._internals
      • CheckMatch
      • Replacement
      • ReplacementOptional
      • Context
      • MatchType
      • Rule
      • RuleOptional
      • Category
      • SupportsBool