Skip to content

CHANGELOG.md

Latest commit

 

History

History
174 lines (146 loc) · 8.21 KB

CHANGELOG.md

File metadata and controls

174 lines (146 loc) · 8.21 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

3.9.0 - 2026-08-11

Added

  • Added support for using multiple glossaries in text and document translation via the glossary_ids option (up to 5 glossary IDs) in translate and document upload.
  • Added support for using a style rule in document translation via the style_id option (the style_rule option) in document upload.
  • Added support for using a translation memory in document translation via the translation_memory_id option (the translation_memory and translation_memory_threshold options) in document upload.
  • Added support for translation memory management via DeepL.translation_memories: find(), segments(), destroy(), create_import(), upload_file(), create_export(), find_job(), wait_until_job_done(), download_export(), and the convenience methods import_from_filepath() and export_to_filepath(). Every method taking a translation memory accepts a string ID or a TranslationMemory object. wait_until_job_done(), import_from_filepath() and export_to_filepath() accept an optional timeout_s to stop waiting for a job that does not finish. Please refer to the README for usage instructions.
  • Added the creation_time and updated_time attributes to TranslationMemory.

Changed

  • Reworked the test suite to run against the deepl-mock server with OpenAPI request and response validation enabled in CI, replacing recorded VCR cassettes. Added live integration and error-path specs across all endpoints, with resource-level unit specs for response field mapping.

Removed

  • Dropped VCR cassette playback and the vcr and webmock development dependencies.

3.8.0 - 2026-05-27

Added

  • Added support for passing additional HTTP headers to translate() and rephrase(). This can be used to send the X-DeepL-Reporting-Tag header for usage reporting.

3.7.0 - 2026-05-14

Added

  • Added support for listing translation memories via DeepL.translation_memories.list.
  • Added translation_memory and translation_memory_threshold parameters to translate() to use a translation memory during text translation. The translation_memory parameter accepts a string ID or a TranslationMemory object.
  • Added support for style rules CRUD operations via DeepL.style_rules: create(), find(), update_name(), update_configured_rules(), and destroy().
  • Added support for style rule custom instruction CRUD operations via DeepL.style_rules: create_custom_instruction(), find_custom_instruction(), update_custom_instruction(), and destroy_custom_instruction(). Please refer to the README for usage instructions.

Changed

  • Updated unit test to expect the model_type_used to now be quality_optimized
  • Set explicit image for gitlab release CI job to avoid missing $HOME issues

3.6.1 - 2025-12-19

Fixed

  • Fixed broken 3.6.0 release

3.6.0 - 2025-12-10

Added

  • Added tag_handling_version parameter to translate() to specify which version of the tag handling algorithm to use. Options are v1 and v2.

Fixed

  • extra_body_parameters will no longer cast values to string, as this library sends JSON-encoded requests (allows e.g. sending booleans)

3.5.1 - 2025-12-19

Fixed

  • Fixed broken 3.5.0 release

3.5.0 - 2025-12-03

Added

  • Added custom_instructions parameter to translate() to customize translation behavior with up to 10 instructions (max 300 characters each). Only supported for target languages: de, en, es, fr, it, ja, ko, zh and their variants. Note: using the custom_instructions parameter will use the quality_optimized model type as the default. Requests combining custom_instructions and the latency_optimized model type will be rejected.

3.4.1 - 2025-12-19

Fixed

  • Fixed broken 3.4.0 release

3.4.0 - 2025-11-17

Added

  • Added support for the GET /v3/style_rules endpoint in the client library, the implementation can be found in the StyleRuleApi class. Please refer to the README for usage instructions
  • Added style_id option to translate() which allows text translation with style rules.

Fixed

  • Send correct library version in user-agent. Expose library version in the module as a variable.

3.3.0 - 2025-11-04

Added

  • Added extra_body_parameters option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as target_lang, source_lang, etc.).
  • Added rephrase functionality to the top-level DeepL module for convenience.

3.2.0 - 2025-01-15

Added

  • Added rephrase functionality to get a new version of submitted text with various possible styles or tones applied
  • Added DeepL::Constants namespace and associated constant values for options possibilities

3.1.0 - 2024-11-15

Added

  • Added model_type option to translate() to use models with higher translation quality (available for some language pairs), or better latency. Options are 'quality_optimized', 'latency_optimized', and 'prefer_quality_optimized'
  • Added the model_type_used field to the translate() response, that indicates the translation model used when the model_type option is specified.

3.0.2 - 2024-10-02

Added

  • Added doc example and tests for context parameter

Fixed

  • Fix metadata displayed on RubyGems.org for this library.
  • Fixed library version sent in the User-Agent string.

3.0.1 - 2024-09-23

Fixed

  • document.translate_document required a filename, this is now optional. The example in the README now works.

3.0.0 - 2024-09-20

Beginning with version 3, deepl-rb is officially supported by DeepL, and maintained together with Daniel Herzog the developer of earlier versions of this library. The change in major version is only due to the change in maintainership, there is no migration necessary from v2 to v3.

Added

  • Added rubocop-rspec linting for rspec test files
  • Added document translation to the ruby CL
  • Added possibility to use one HTTP session for multiple calls
  • Added platform and ruby version information to the user-agent string that is sent with API calls, along with an opt-out
  • Added support for logging of HTTP requests
  • Added support for using a proxy and a custom certificate file
  • Added a gitlab CI pipeline

Changed

  • HTTP requests to the DeepL API now use application/json, rather than application/www-form-unencoded
  • HTTP requests now automatically retry on transient failures, using exponential backoff

Removed

  • Removed CircleCI and CodeCov upload

2.5.3 - 2022-09-26

Fixed

  • Make RequestEntityTooLarge error message more clear