mindee 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8eb9e96fa7c4b8a41479c87152f858112a72c52f18c23ad247c220615d4df15
-  data.tar.gz: 44da90b0f6e814f13cd418502998e3e17610e76857199744c8f2e98b217d72c0
+  metadata.gz: cda258819aabaa34266728d26130b0137ad8d86d770c9d395245e373b1bc96e4
+  data.tar.gz: 5fbbd21a967ff60ddc059fa9ed9d5f3fd7422890e3f3675d38347f82a5463da8
 SHA512:
-  metadata.gz: 543a63c5085472676f044b20721f03844ad3f425f4fef936c147240b0c286da6f81d8ceffb9ebb90b6c70340426e0529350406b0acfb685176cedb85968ddc06
-  data.tar.gz: 591a11727b309a1ac91840ae3dc260f1bcd5186c840b82a71bdc815a8dd3741500191801491ce25edcc44178077d5dd02d437b1c388f9164f1b80c49114a9ea4
+  metadata.gz: 956efea9a0245e734c9c1b313ad0e1a74f9c5245df05f3bb1e17ab2a3b4a5031b9d0fc21110f0db33dd08d85d0427cfda1c6f265b05177e1900b761274398fb0
+  data.tar.gz: c2845fc9b049a1b123b15678e4effdfb55f382650cb9eecc90244ec553a78679dd1523226e8826a5e3abfbcc95bff85c790aeabcde10d36696cffa977594e3c4

data/.rubocop.yml

@@ -47,3 +47,7 @@ Metrics/AbcSize:
 
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
+
+Style/ArrayIntersect:
+  Exclude:
+    - 'lib/mindee/pdf/pdf_tools.rb'

data/CHANGELOG.md

@@ -1,12 +1,23 @@
 # Mindee Ruby API Library Changelog
 
+## v5.4.0 - 2026-07-21
+### Changes
+* :sparkles: add field confidence comparators
+* :sparkles: add support for cancellation token
+
+
+## v5.3.1 - 2026-07-15
+### Fixes
+* :bug: fix file alias being sent as an invalid parameter
+
+
 ## v5.3.0 - 2026-07-03
-### Changes:
+### Changes
 * :memo: add SKILL file
 * :recycle: use generic array types for images, PDFs
 * :sparkles: allow passing webhooks to the CLI
 * :sparkles: add webhook error response
-### Fixes:
+### Fixes
 * :bug: fix for extraction method naming
 
 ## v5.2.2 - 2026-06-18

data/lib/mindee/http/cancellation_token.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mindee
+  module HTTP
+    # Custom cancellation token class for polling.
+    class CancellationToken
+      private attr_reader :is_canceled
+
+      def initialize
+        @is_cancelled = false
+      end
+
+      # Cancel the token.
+      def cancel
+        @is_cancelled = true
+      end
+
+      # Check if the token is canceled.
+      def canceled?
+        @is_cancelled
+      end
+    end
+  end
+end

data/lib/mindee/http.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative 'http/cancellation_token'
 require_relative 'http/http_error_handler'

data/lib/mindee/input/base_parameters.rb

@@ -101,7 +101,7 @@ module Mindee
       # @param [Array] form_data Array of form fields
       # @return [Array]
       def append_form_data(form_data)
-        form_data.push(['file_alias', @file_alias]) if @file_alias
+        form_data.push(['alias', @file_alias]) if @file_alias
         webhook_ids = @webhook_ids || []
         form_data.push(['webhook_ids', webhook_ids.join(',')]) unless @webhook_ids.nil? || webhook_ids.empty?
         form_data

data/lib/mindee/v1/client.rb

@@ -219,6 +219,7 @@ module Mindee
         Mindee::V1::Parsing::Common::ApiResponse.new(product_class, prediction, raw_http)
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       # Enqueue a document for async parsing and automatically try to retrieve it
       #
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
@@ -247,13 +248,23 @@ module Mindee
       #   * `:delay_sec` [Numeric] Delay between polling attempts. Defaults to 1.5.
       #   * `:max_retries` [Integer] Maximum number of retries. Defaults to 80.
       # @param endpoint [Mindee::V1::HTTP::Endpoint] Endpoint of the API.
+      # @param cancellation_token [Mindee::HTTP::CancellationToken, nil] Token for cancellation.
       # @return [Mindee::V1::Parsing::Common::ApiResponse]
-      def enqueue_and_parse(input_source, product_class, endpoint, options)
+      # rubocop:disable Metrics/PerceivedComplexity
+      def enqueue_and_parse(
+        input_source,
+        product_class,
+        endpoint,
+        options,
+        cancellation_token = nil
+      )
         validate_async_params(options.initial_delay_sec, options.delay_sec, options.max_retries)
         enqueue_res = enqueue(input_source, product_class, endpoint: endpoint, options: options)
         job = enqueue_res.job or raise Error::MindeeAPIError, 'Expected job to be present'
         job_id = job.id
 
+        raise Mindee::Error::MindeeError, 'Enqueueing of the document was canceled.' if cancellation_token&.canceled?
+
         sleep(options.initial_delay_sec)
         polling_attempts = 1
         logger.debug("Successfully enqueued document with job id: '#{job_id}'")
@@ -266,6 +277,8 @@ module Mindee
         # @type var valid_statuses: Array[(:waiting | :processing | :completed | :failed)]
         while valid_statuses.include?(queue_res_job.status) && polling_attempts < options.max_retries
           logger.debug("Polling server for parsing result with job id: '#{job_id}'. Attempt #{polling_attempts}")
+          raise Mindee::Error::MindeeError, 'Enqueueing of the document was canceled.' if cancellation_token&.canceled?
+
           sleep(options.delay_sec)
           queue_res = parse_queued(job_id, product_class, endpoint: endpoint)
           queue_res_job = queue_res.job or raise Error::MindeeAPIError, 'Expected job to be present'
@@ -280,7 +293,9 @@ module Mindee
 
         queue_res
       end
+      # rubocop:enable Metrics/PerceivedComplexity
 
+      # rubocop:enable Metrics/CyclomaticComplexity
       # Sends a document to a workflow.
       #
       # Accepts options either as a Hash or as a WorkflowOptions struct.

data/lib/mindee/v2/client.rb

@@ -58,12 +58,15 @@ module Mindee
       #   The source of the input document (local file or URL).
       # @param params [Hash, Input::BaseParameters] Parameters for the inference.
       # @param polling_options [Hash, PollingOptions, nil] Parameters for polling.
+      # @param cancellation_token [Mindee::HTTP::CancellationToken, nil] Token for cancellation.
       # @return [Parsing::BaseResponse]
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def enqueue_and_get_result(
         product,
         input_source,
         params,
-        polling_options = nil
+        polling_options = nil,
+        cancellation_token = nil
       )
         enqueue_response = enqueue(product, input_source, params)
         normalized_params = normalize_parameters(product.params_type, params, polling_options: polling_options)
@@ -77,6 +80,8 @@ module Mindee
         job_id = enqueue_response.job.id
         logger.debug("Successfully enqueued document with job id: #{job_id}.")
 
+        raise Mindee::Error::MindeeError, 'Enqueueing of the document was canceled.' if cancellation_token&.canceled?
+
         sleep(normalized_params.polling_options.initial_delay_sec)
         retry_counter = 1
         poll_results = get_job(job_id)
@@ -94,6 +99,8 @@ module Mindee
             "Job status: #{poll_results.job.status}."
           )
 
+          raise Mindee::Error::MindeeError, 'Enqueueing of the document was canceled.' if cancellation_token&.canceled?
+
           sleep(normalized_params.polling_options.delay_sec)
           poll_results = get_job(job_id)
           retry_counter += 1
@@ -110,6 +117,7 @@ module Mindee
         raise Mindee::Error::MindeeError,
               "Asynchronous parsing request timed out after #{sec_count} seconds"
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       # Searches for a list of available models for the given API key.
       # @param model_name [String]

data/lib/mindee/v2/http/mindee_api_v2.rb

@@ -203,7 +203,6 @@ module Mindee
                         [['file', file_data, file_metadata]] # : Array[Array[untyped]]
                       end
           form_data.push(['model_id', params.model_id])
-          form_data.push ['file_alias', params.file_alias] if params.file_alias
           if params.is_a?(V2::Product::Extraction::Params::ExtractionParameters)
             form_data = enqueue_form_options(form_data, params)
           end

data/lib/mindee/v2/parsing/field/field_confidence.rb

@@ -87,8 +87,8 @@ module Mindee
             end
           end
 
-          # less than or equality of two FieldConfidence instances.
-          # # @param other [String, Integer, FieldConfidence] The other confidence to compare.
+          # Less than or equality of two FieldConfidence instances.
+          # @param other [String, Integer, FieldConfidence] The other confidence to compare.
           def <=(other)
             if other.is_a?(FieldConfidence)
               to_i <= val_to_i(other.value)
@@ -101,12 +101,47 @@ module Mindee
             end
           end
 
+          # Greater than comparison of two FieldConfidence instances.
+          # @param other [String, Integer, FieldConfidence] The other confidence to compare.
+          def >(other)
+            if other.is_a?(FieldConfidence)
+              to_i > val_to_i(other.value)
+            elsif other.is_a?(String)
+              to_i > val_to_i(other)
+            elsif other.is_a?(Integer)
+              to_i > other
+            else
+              raise ArgumentError, "Invalid type: #{other.class}"
+            end
+          end
+
+          # Less than comparison of two FieldConfidence instances.
+          # @param other [String, Integer, FieldConfidence] The other confidence to compare.
+          def <(other)
+            if other.is_a?(FieldConfidence)
+              to_i < val_to_i(other.value)
+            elsif other.is_a?(String)
+              to_i < val_to_i(other)
+            elsif other.is_a?(Integer)
+              to_i < other
+            else
+              raise ArgumentError, "Invalid type: #{other.class}"
+            end
+          end
+
           # rubocop:enable Style/CaseLikeIf
 
           # Aliases for the comparison operators.
           alias eql? ==
+          alias equal? ==
           alias gteql? >=
+          alias greater_than_or_equal? >=
           alias lteql? <=
+          alias less_than_or_equal? <=
+          alias gt? >
+          alias greater_than? >
+          alias lt? <
+          alias less_than? <
 
           protected
 

data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb

@@ -46,7 +46,7 @@ module Mindee
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids
             # @param [String, nil] text_context
-            # @param [Hash, PollingOptions, nil] polling_options
+            # @param [Hash, Input::PollingOptions, nil] polling_options
             # @param [Boolean, nil] close_file
             # @param [DataSchemaField, String, Hash nil] data_schema
             def initialize(

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '5.3.0'
+  VERSION = '5.4.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/sig/mindee/http/cancellation_token.rbs

@@ -0,0 +1,15 @@
+# lib/http/cancellation_token.rb
+
+module Mindee
+  module HTTP
+    class CancellationToken
+      @is_cancelled: bool
+
+      attr_reader is_canceled: bool
+
+      def canceled?: -> bool
+      def initialize: -> void
+      def cancel: -> void
+    end
+  end
+end

data/sig/mindee/input/base_parameters.rbs

@@ -20,17 +20,17 @@ module Mindee
           String,
           ?file_alias: String?,
           ?webhook_ids: Array[String]?,
-          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
+          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions | nil,
           ?close_file: bool?
         ) -> void
 
       def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
       def validate_async_params: () -> void
-      def polling_options=: (Hash[Symbol | String, untyped] | PollingOptions?) -> PollingOptions
+      def polling_options=: (Hash[Symbol | String, untyped] | PollingOptions | nil) -> PollingOptions
 
       private
 
-      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
+      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions | nil) -> PollingOptions
     end
   end
 end

data/sig/mindee/v2/client.rbs

@@ -17,13 +17,13 @@ module Mindee
 
       def enqueue: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> V2::Parsing::JobResponse
 
-      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions?) -> T
+      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> T
 
       def search_models: (String?, String?) -> Mindee::V2::Parsing::Search::SearchResponse
 
       def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
 
-      def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?polling_options: Hash[String | Symbol, untyped] | Input::PollingOptions?) -> Input::BaseParameters
+      def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?polling_options: Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> Input::BaseParameters
     end
   end
 end

data/sig/mindee/v2/parsing/field/field_confidence.rbs

@@ -20,6 +20,15 @@ module Mindee
           def lteql? : (String | Integer | FieldConfidence) -> bool
           def >=: (String | Integer | FieldConfidence) -> bool
           def gteql?: (String | Integer | FieldConfidence) -> bool
+          def greater_than_or_equal?: (String | Integer | FieldConfidence) -> bool
+          def >: (String | Integer | FieldConfidence) -> bool
+          def gt?: (String | Integer | FieldConfidence) -> bool
+          def greater_than?: (String | Integer | FieldConfidence) -> bool
+          def <: (String | Integer | FieldConfidence) -> bool
+          def lt?: (String | Integer | FieldConfidence) -> bool
+          def less_than?: (String | Integer | FieldConfidence) -> bool
+          def less_than_or_equal?: (String | Integer | FieldConfidence) -> bool
+          def equal?: (String | Integer | FieldConfidence) -> bool
           def inspect: -> String
 
           def val_to_i: (String) -> Integer

data/sig/mindee/v2/product/classification/params/classification_parameters/classification_parameters.rbs

@@ -12,7 +12,7 @@ module Mindee
                 String,
                 ?file_alias: String?,
                 ?webhook_ids: Array[String]?,
-                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions | nil,
                 ?close_file: bool?
               ) -> void
           end

data/sig/mindee/v2/product/crop/params/crop_parameters/crop_parameters.rbs

@@ -12,7 +12,7 @@ module Mindee
                 String,
                 ?file_alias: String?,
                 ?webhook_ids: Array[String]?,
-                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions | nil,
                 ?close_file: bool?
               ) -> void
           end

data/sig/mindee/v2/product/extraction/params/extraction_parameters.rbs

@@ -23,7 +23,7 @@ module Mindee
                 ?file_alias: String?,
                 ?text_context: String?,
                 ?webhook_ids: Array[String]?,
-                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions | nil,
                 ?close_file: bool?,
                 ?data_schema: V2::Product::Extraction::Params::DataSchema|String|Hash[Symbol | String, untyped]?
               ) -> void

data/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs

@@ -12,7 +12,7 @@ module Mindee
                 String,
                 ?file_alias: String?,
                 ?webhook_ids: Array[String]?,
-                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions | nil,
                 ?close_file: bool?
               ) -> void
           end

data/sig/mindee/v2/product/split/params/split_parameters/split_parameters.rbs

@@ -12,7 +12,7 @@ module Mindee
                 String,
                 ?file_alias: String?,
                 ?webhook_ids: Array[String]?,
-                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions | nil,
                 ?close_file: bool?
               ) -> void
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-03 00:00:00.000000000 Z
+date: 2026-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -247,6 +247,7 @@ files:
 - lib/mindee/geometry/utils.rb
 - lib/mindee/http.rb
 - lib/mindee/http/.rubocop.yml
+- lib/mindee/http/cancellation_token.rb
 - lib/mindee/http/http_error_handler.rb
 - lib/mindee/http/response_validation.rb
 - lib/mindee/image.rb
@@ -491,6 +492,7 @@ files:
 - sig/mindee/geometry/polygon.rbs
 - sig/mindee/geometry/quadrilateral.rbs
 - sig/mindee/geometry/utils.rbs
+- sig/mindee/http/cancellation_token.rbs
 - sig/mindee/http/http_error_handler.rbs
 - sig/mindee/http/response_validation.rbs
 - sig/mindee/image/extracted_image.rbs