deepl-rb 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ed15fdabc7d3b893b4590bda599106140c9c06c7d4d67cc6ff2a679a05ba301
-  data.tar.gz: fee679c9456728c0679ebdf66ea501d7924eb49e9e1e480520a50a6c7cfed3d9
+  metadata.gz: 1de43b1593c5b5d4236c0b064c08436ab57fe13bf3fdc29069220fd899ca8e1d
+  data.tar.gz: a486d446fa3bebddbf3fd6aa468300bead03eafe8bc075c33a28d80be6e555b8
 SHA512:
-  metadata.gz: eefd241705fc379dd6de1574a63f83380cb445a6d883c7d2db6da3827691b79845b06f37227c0ea0285738066ba1850782e0462ec9fab9a02816205ab416ba35
-  data.tar.gz: c6f0789c07f2f23c27a9ee979812b0d76bde2edb308cd2e6c422f826a089f561cdb6c80317dfecb27ed94d9f2ee6c6340135548ea3866bb21084896da28ceb3d
+  metadata.gz: ca167089f7a190915436fb316a8a82aa69bf8093316b4074c6536bb21e002811d9bdd57fc8711eeb634025b094a9fe17e2b057eee5ea5d2499539060e09b8ebd
+  data.tar.gz: 1c63cd745170652f01a2335cc064ceb0266c1584a19bd1fcd6683c6d461241b646d33df0b3e36f516e1dff6a1d6158e706994b862b6bd8d671b1db399cabfa03

data/CHANGELOG.md

@@ -5,6 +5,16 @@ 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.1.0]
+### 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
@@ -41,6 +51,7 @@ The change in major version is only due to the change in maintainership, there i
 * Make RequestEntityTooLarge error message more clear
 
 
+[3.1.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.2...v3.1.0
 [3.0.2]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.1...v3.0.2
 [3.0.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.3...v3.0.0

data/README.md

@@ -137,6 +137,23 @@ puts translation.text
 # => "¡Eso es picante!"
 ```
 
+To specify a type of translation model to use, you can use the `model_type` option:
+
+```rb
+translation = DeepL.translate 'That is hot!', 'EN', 'DE',
+                              model_type: 'quality_optimized'
+```
+
+This would use next-gen translation models for the translation. The available values are
+
+- `'quality_optimized'`: use a translation model that maximizes translation quality, at the
+  cost of response time. This option may be unavailable for some language pairs.
+- `'prefer_quality_optimized'`: use the highest-quality translation model for the given
+  language pair.
+- `'latency_optimized'`: use a translation model that minimizes response time, at the cost
+  of translation quality.
+
+
 The following parameters will be automatically converted:
 
 | Parameter             | Conversion

data/VERSION

@@ -1 +1 @@
-3.0.2
+3.1.0

data/deepl-rb.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.0.2 ruby lib
+# stub: deepl-rb 3.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.0.2"
+  s.version = "3.1.0"
 
   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=
   s.require_paths = ["lib".freeze]
   s.authors = ["DeepL SE".freeze]
-  s.date = "2024-10-02"
+  s.date = "2024-11-15"
   s.description = "Official Ruby library for the DeepL language translation API (v2). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "open-source@deepl.com".freeze
   s.extra_rdoc_files = [

data/lib/deepl/requests/translate.rb

@@ -27,7 +27,7 @@ module DeepL
       }.freeze
 
       attr_reader :text, :source_lang, :target_lang, :ignore_tags, :splitting_tags,
-                  :non_splitting_tags
+                  :non_splitting_tags, :model_type
 
       def initialize(api, text, source_lang, target_lang, options = {})
         super(api, options)
@@ -68,7 +68,7 @@ module DeepL
 
         texts = data['translations'].map do |translation|
           Resources::Text.new(translation['text'], translation['detected_source_language'],
-                              request, response)
+                              translation['model_type_used'], request, response)
         end
 
         texts.size == 1 ? texts.first : texts

data/lib/deepl/resources/text.rb

@@ -6,13 +6,14 @@
 module DeepL
   module Resources
     class Text < Base
-      attr_reader :text, :detected_source_language
+      attr_reader :text, :detected_source_language, :model_type_used
 
-      def initialize(text, detected_source_language, *args)
+      def initialize(text, detected_source_language, model_type_used, *args)
         super(*args)
 
         @text = text
         @detected_source_language = detected_source_language
+        @model_type_used = model_type_used
       end
 
       def to_s

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -10237,4 +10237,136 @@ http_interactions:
       string: !binary |-
         eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IsKhRXNvIGVzIHBpY2FudGUhIn1dfQ==
   recorded_at: Wed, 25 Sep 2024 16:08:00 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"quality_optimized"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      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:
+      Date:
+      - Fri, 08 Nov 2024 15:57:39 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=89, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=165
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 7d71b768eebc41da8c5b820c33e7cdc1
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Mustertext","model_type_used":"quality_optimized"}]}'
+  recorded_at: Fri, 08 Nov 2024 15:57:39 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"prefer_quality_optimized"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      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:
+      Date:
+      - Mon, 11 Nov 2024 10:58:59 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=98, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=320
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 0fa07be47b3b458ebf50268ca2efe7fe
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Mustertext","model_type_used":"quality_optimized"}]}'
+  recorded_at: Mon, 11 Nov 2024 10:58:59 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"latency_optimized"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      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:
+      Date:
+      - Fri, 15 Nov 2024 11:35:22 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=136, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=156
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - de2645cb65c3418db54e3bdefd35fe52
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Beispieltext","model_type_used":"latency_optimized"}]}'
+  recorded_at: Fri, 15 Nov 2024 11:35:22 GMT
 recorded_with: VCR 6.2.0

data/spec/requests/translate_spec.rb

@@ -190,6 +190,18 @@ describe DeepL::Requests::Translate do
         expect(request.options[:formality]).to eq('more')
       end
     end
+
+    context 'when using `model_type` options' do
+      it 'works with a nil value' do
+        request = described_class.new(api, nil, nil, nil, model_type: nil)
+        expect(request.options[:model_type]).to be_nil
+      end
+
+      it 'works with a string' do
+        request = described_class.new(api, nil, nil, nil, model_type: 'latency_optimized')
+        expect(request.options[:model_type]).to eq('latency_optimized')
+      end
+    end
   end
 
   describe '#request' do
@@ -316,6 +328,21 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when performing a request with a model type' do
+      let(:target_lang) { 'DE' }
+
+      %w[quality_optimized latency_optimized prefer_quality_optimized].each do |model_type_str|
+        it "translates correctly with #{model_type_str} models" do
+          options = { model_type: model_type_str }
+          translate = described_class.new(api, text, source_lang, target_lang, options)
+          res = translate.request
+          expect(res).to be_a(DeepL::Resources::Text)
+          expected_model_type = model_type_str.sub(/^prefer_/, '')
+          expect(res.model_type_used).to eq(expected_model_type)
+        end
+      end
+    end
+
     context 'when performing a bad request' do
       context 'when using an invalid token' do
         let(:api) do

data/spec/resources/text_spec.rb

@@ -6,7 +6,7 @@
 require 'spec_helper'
 
 describe DeepL::Resources::Text do
-  subject(:text) { described_class.new('Target', 'es', nil, nil) }
+  subject(:text) { described_class.new('Target', 'es', nil, nil, nil) }
 
   describe '#initialize' do
     context 'when building a basic object' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier