deepl-rb 3.4.1 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c41f4e48cdf057f165925df1ba47e6fa2748d49816a16e137e4ed8acaed7000
-  data.tar.gz: b169350c8f173e15bc502d7eaa26c6b9b4b255961224a6508ac41eaa0d7466c3
+  metadata.gz: a72aff32a39743d19e811efa5a3e9d5687b90c0f3f06e1545b3746143a7478b7
+  data.tar.gz: 02b0f280c59a81c24771a2c2d4248d9fb4d32bcb3a635dc9e8a0a8cf6ce8db71
 SHA512:
-  metadata.gz: 0d260ad680a40b28865127fd0eaccd469c7dc5fed1203424c3737077b6d5b6a7dc6116b3d458633f8c3d4835159b5deb1e49bafa43409a1255abd3f11ccbbba6
-  data.tar.gz: 1d684b486e4286f02d6bbc194bcf983ee7e5555d263d52cc5b41d68abba2fbafe79bae96f014b1db841b9fb893b173dc66f12365b7734bbd3bfb9a891ff97b41
+  metadata.gz: c292502b6e5c35a73f79ddacbe7f44ea2c1ba51d12eb137a795e44f6f10c56f397277eea272faf193a4fb14c6f639fe597c0c066feca1cce03ad5584cf2d3224
+  data.tar.gz: 31f9cfdd8e9f762f30ff37e5de3aa3466527330e14aa6378d0c1bc2454c9f78249a74546998bfbf90ba56ef46e77fe4c09885cc82d489db615ab7a2ff89f3f7e

data/CHANGELOG.md

@@ -4,9 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [3.4.1] - 2025-12-19
+## [3.5.1] - 2025-12-19
 ### Fixed
-- Fixed broken 3.4.0 release
+- 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.0] - 2025-11-17
 ### Added
@@ -75,7 +84,8 @@ The change in major version is only due to the change in maintainership, there i
 ### Fixed
 - Make RequestEntityTooLarge error message more clear
 
-[3.4.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.4.1
+[3.5.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.0...v3.5.1
+[3.5.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.5.0
 [3.4.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...v3.2.0

data/README.md

@@ -153,6 +153,19 @@ This would use next-gen translation models for the translation. The available va
 - `'latency_optimized'`: use a translation model that minimizes response time, at the cost
   of translation quality.
 
+To translate with custom instructions, supply the `custom_instructions` parameter:
+
+```rb
+translation = DeepL.translate 'Hello, world!', 'EN', 'DE',
+                              custom_instructions: ['Use informal language', 'Be concise']
+
+puts translation.text
+```
+
+Up to 10 custom instructions can be specified, each with a maximum of 300 characters.
+The target language must be `de`, `en`, `es`, `fr`, `it`, `ja`, `ko`, `zh` or any variants.
+Note that using `custom_instructions` will automatically use `quality_optimized` models,
+and cannot be combined with `model_type: 'latency_optimized'`.
 
 The following parameters will be automatically converted:
 
@@ -169,6 +182,7 @@ The following parameters will be automatically converted:
 | `style_id`            | No conversion applied
 | `style_rule`          | No conversion applied (can be a string ID or a StyleRule object)
 | `context`             | No conversion applied
+| `custom_instructions` | No conversion applied
 | `extra_body_parameters` | Hash of extra parameters to pass in the body of the HTTP request. Can be used to access beta features, or to override built-in parameters for testing purposes. Extra parameters can override keys explicitly set by the client.
 
 ### Rephrase Text

data/VERSION

@@ -1 +1 @@
-3.4.1
+3.5.1

data/deepl-rb.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.4.1 ruby lib
+# stub: deepl-rb 3.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.4.1"
+  s.version = "3.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.metadata = { "bug_tracker_uri" => "https://github.com/DeepLcom/deepl-rb/issues", "changelog_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/CHANGELOG.md", "documentation_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/README.md", "homepage_uri" => "https://github.com/DeepLcom/deepl-rb" } if s.respond_to? :metadata=

data/lib/deepl/requests/translate.rb

@@ -23,11 +23,12 @@ module DeepL
         outline_detection: STRING_TO_BOOLEAN_CONVERSION,
         splitting_tags: STRING_TO_ARRAY_CONVERSION,
         non_splitting_tags: STRING_TO_ARRAY_CONVERSION,
-        ignore_tags: STRING_TO_ARRAY_CONVERSION
+        ignore_tags: STRING_TO_ARRAY_CONVERSION,
+        custom_instructions: STRING_TO_ARRAY_CONVERSION
       }.freeze
 
       attr_reader :text, :source_lang, :target_lang, :ignore_tags, :splitting_tags,
-                  :non_splitting_tags, :model_type
+                  :non_splitting_tags, :model_type, :custom_instructions
 
       def initialize(api, text, source_lang, target_lang, options = {})
         super(api, options)

data/lib/version.rb

@@ -4,5 +4,5 @@
 # frozen_string_literal: true
 
 module DeepL
-  VERSION = '3.4.1'
+  VERSION = '3.5.1'
 end

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -10412,4 +10412,47 @@ http_interactions:
       string: !binary |-
         eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IlRleHRlIG1vZMOobGUifV19
   recorded_at: Tue, 28 Oct 2025 12:50:23 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Hello world"],"source_lang":"EN","target_lang":"DE","custom_instructions":["Use
+        formal language","Be concise"]}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.5.0 (darwin24) ruby/3.2.2
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 03 Dec 2025 06:07:36 GMT
+      X-Trace-Id:
+      - b50df453ea8d451bbd67df63f68e66da
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=117, l7_lb_idle;dur=4, l7_lb_receive;dur=0, l7_lb_total;dur=340
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"text":"Sehr geehrte Damen und Herren","detected_source_language":"EN"}]}'
+  recorded_at: Wed, 03 Dec 2025 06:07:36 GMT
 recorded_with: VCR 6.3.1

data/spec/requests/translate_spec.rb

@@ -225,6 +225,30 @@ describe DeepL::Requests::Translate do
         expect(request.options[:model_type]).to eq('latency_optimized')
       end
     end
+
+    context 'when using `custom_instructions` options' do
+      it 'works with a nil value' do
+        request = described_class.new(api, nil, nil, nil, custom_instructions: nil)
+        expect(request.options[:custom_instructions]).to be_nil
+      end
+
+      it 'works with an array of strings' do
+        instructions = ['Use informal language', 'Be concise']
+        request = described_class.new(api, nil, nil, nil, custom_instructions: instructions)
+        expect(request.options[:custom_instructions]).to eq(instructions)
+      end
+
+      it 'works with a single string' do
+        request = described_class.new(api, nil, nil, nil, custom_instructions: ['Be concise'])
+        expect(request.options[:custom_instructions]).to eq(['Be concise'])
+      end
+
+      it 'works with a single string and converts it to an array' do
+        instructions = 'Use informal language,Be concise'
+        request = described_class.new(api, nil, nil, nil, custom_instructions: instructions)
+        expect(request.options[:custom_instructions]).to eq(['Use informal language', 'Be concise'])
+      end
+    end
   end
 
   describe '#request' do
@@ -378,6 +402,19 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when performing a request with custom_instructions' do
+      let(:text) { 'Hello world' }
+      let(:target_lang) { 'DE' }
+
+      it 'includes custom_instructions in the payload' do
+        options = { custom_instructions: ['Use formal language', 'Be concise'] }
+        translate = described_class.new(api, text, source_lang, target_lang, options)
+
+        # Verify the options are properly stored
+        expect(translate.options[:custom_instructions]).to eq(['Use formal language', 'Be concise'])
+      end
+    end
+
     context 'when performing a bad request' do
       context 'when using an invalid token' do
         let(:api) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.1
 platform: ruby
 authors:
 - DeepL SE