mindee 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c130d39c720927dbf32f427f50e3b6e64f43573a419adcae4b2c24b88825ceda
-  data.tar.gz: 11bea996953560479ccfec44fac65ed77ac83b45be0ceb64458d1e019fc3604d
+  metadata.gz: 4035b0201f4458b0bdb6066c4602d132ef2695436d47d2c36f27a5eccf8c5af8
+  data.tar.gz: dfa07b33ef6c2da5f5d973fa47c01ff969bcd011e3b595785f2f06dd411b4c4c
 SHA512:
-  metadata.gz: cc9f76a7449ce3a9f9d99ff2cc03c545d5aadff3a088e817b34e2fb280ba1807b9bb8d1edfba3612e5929a7f51e9e4e007fe4f20bce4d4ba69c246aca3137ef3
-  data.tar.gz: 134e8286afd4e28a54a3523a9e691bb2ede3a631684d1640023badcdf758801b1b1a6eac4af6eddefe64d28f8659163feb05806024a5c6d33575c5bd002b8f2e
+  metadata.gz: 620d7b8e30cb6368451485d4119a357f991b5105c73d7407d18294ef440c17d2d0602960a00742fb5a3969d33cd7308a8771833bb01fd2fb8bfd74eb64fc5fef
+  data.tar.gz: 10644668f5aa9b0c2848e252cfe8174368c3bd49f5483028c9d0a7e316356986c0300acd875e162156e5338ff53d3d297e47aec5fd33ca9824e39d3d3181272b

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Mindee Ruby API Library Changelog
 
+## v5.2.0 - 2026-05-19
+### Changes
+* :sparkles: add webhook info to model searches
+
+
+## v5.1.0 - 2026-05-13
+### Changes
+* :sparkles: Add support for extraction in crop, split, and classify products
+* :sparkles: add typed accessors for SimpleField
+
+
 ## v5.0.0 - 2026-04-20
 ### ¡Breaking Changes!
 * :boom: :recycle: update V1 & V2 syntaxes to match other SDKs

data/docs/code_samples/v2_extraction.txt

@@ -40,3 +40,10 @@ response = mindee_client.enqueue_and_get_result(
 
 # Print a brief summary of the parsed data
 puts response.inference
+
+# Access the result fields
+fields = response.inference.result.fields
+
+# fields.get_simple_field('my_simple_field')
+# fields.get_list_field('my_list_field')
+# fields.get_object_field('my_object_field')

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

@@ -38,6 +38,38 @@ module Mindee
             end
           end
 
+          # Retrieves the field value as a Float.
+          # @return [Float, nil]
+          # @raise [RuntimeError] If the value is not a Float.
+          def float_value
+            raise "Value is not a float: #{@value.class}" unless @value.nil? || @value.is_a?(Float)
+
+            val = @value
+            val.is_a?(Float) ? val : nil # @type var val: Float | nil
+          end
+
+          # Retrieves the field value as a String.
+          # @return [String, nil]
+          # @raise [RuntimeError] If the value is not a String.
+          def string_value
+            raise "Value is not a string: #{@value.class}" unless @value.nil? || @value.is_a?(String)
+
+            val = @value
+            val.is_a?(String) ? val : nil # @type var val: String | nil
+          end
+
+          # Retrieves the field value as a Boolean.
+          # @return [Boolean, nil]
+          # @raise [RuntimeError] If the value is not a Boolean.
+          def boolean_value
+            unless @value.nil? || @value.is_a?(TrueClass) || @value.is_a?(FalseClass)
+              raise "Value is not a boolean: #{@value.class}"
+            end
+
+            val = @value
+            @value.is_a?(TrueClass) || @value.is_a?(FalseClass) ? val : nil # @type var val: bool | nil
+          end
+
           private
 
           # Format numeric values to display '.0' in string reps.

data/lib/mindee/v2/parsing/search/model_webhook.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Individual webhook information.
+        class ModelWebhook
+          # @return [String] ID of the webhook.
+          attr_reader :id
+
+          # @return [String] Name of the webhook.
+          attr_reader :name
+
+          # @return [String] URL of the webhook.
+          attr_reader :url
+
+          # @param payload [Hash] The parsed JSON payload mapping to the search model.
+          def initialize(payload)
+            @id = payload['id']
+            @name = payload['name']
+            @url = payload['url']
+          end
+
+          # String representation of the model.
+          # @return [String]
+          def to_s
+            [
+              ":Name: #{@name}",
+              ":ID: #{@id}",
+              ":URL: #{@url}",
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_model.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'model_webhook'
+
 module Mindee
   module V2
     module Parsing
@@ -15,11 +17,15 @@ module Mindee
           # @return [String] Type of the model.
           attr_reader :model_type
 
+          # @return [Array<ModelWebhook>] List of webhooks associated with the model.
+          attr_reader :webhooks
+
           # @param payload [Hash] The parsed JSON payload mapping to the search model.
           def initialize(payload)
             @id = payload['id']
             @name = payload['name']
             @model_type = payload['model_type']
+            @webhooks = (payload['webhooks'] || []).map { |w| ModelWebhook.new(w) }
           end
 
           # String representation of the model.
@@ -29,6 +35,7 @@ module Mindee
               ":Name: #{@name}",
               ":ID: #{@id}",
               ":Model Type: #{@model_type}",
+              ":Webhooks: #{@webhooks.join("\n")}",
             ].join("\n")
           end
         end

data/lib/mindee/v2/parsing/search/search_models.rb

@@ -20,6 +20,7 @@ module Mindee
                 "* :Name: #{model.name}",
                 "  :ID: #{model.id}",
                 "  :Model Type: #{model.model_type}",
+                "  :Webhooks: #{model.webhooks.size}",
               ]
             end
 

data/lib/mindee/v2/parsing/search/search_response.rb

@@ -24,10 +24,10 @@ module Mindee
             [
               'Models',
               '######',
-              models.to_s,
+              @models.to_s,
               'Pagination Metadata',
               '###################',
-              pagination_metadata.to_s,
+              @pagination_metadata.to_s,
               '',
             ].join("\n")
           end

data/lib/mindee/v2/parsing/search.rb

@@ -4,3 +4,4 @@ require_relative 'search/pagination_metadata'
 require_relative 'search/search_model'
 require_relative 'search/search_models'
 require_relative 'search/search_response'
+require_relative 'search/model_webhook'

data/lib/mindee/v2/product/classification/classification_classifier.rb

@@ -8,10 +8,16 @@ module Mindee
         class ClassificationClassifier
           # @return [String] The document type, as identified on given classification values.
           attr_reader :document_type
+          attr_reader :extraction_response
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @document_type = server_response['document_type']
+            # rubocop:disable Style/GuardClause
+            unless server_response['extraction_response'].nil?
+              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+            end
+            # rubocop:enable Style/GuardClause
           end
 
           # @return [String] String representation.

data/lib/mindee/v2/product/crop/crop_item.rb

@@ -10,11 +10,17 @@ module Mindee
           attr_reader :object_type
           # @return [V2::Parsing::Field::FieldLocation] Coordinates of the detected object on the document.
           attr_reader :location
+          attr_reader :extraction_response
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @object_type = server_response['object_type']
             @location = Mindee::V2::Parsing::Field::FieldLocation.new(server_response['location'])
+            # rubocop:disable Style/GuardClause
+            unless server_response['extraction_response'].nil?
+              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+            end
+            # rubocop:enable Style/GuardClause
           end
 
           # String representation.

data/lib/mindee/v2/product/split/split_range.rb

@@ -11,11 +11,17 @@ module Mindee
           attr_reader :page_range
           # @return [String] The document type, as identified on given classification values.
           attr_reader :document_type
+          attr_reader :extraction_response
 
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @page_range = server_response['page_range']
             @document_type = server_response['document_type']
+            # rubocop:disable Style/GuardClause
+            unless server_response['extraction_response'].nil?
+              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+            end
+            # rubocop:enable Style/GuardClause
           end
 
           # String representation.

data/lib/mindee/version.rb

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

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

@@ -4,9 +4,13 @@ module Mindee
     module Parsing
       module Field
         class SimpleField < BaseField
-          attr_reader value: String | Integer | Float | bool | nil
+          attr_reader value: String | Float | bool | nil
 
           def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def boolean_value: -> (bool | nil)
+          def float_value: -> (Float | nil)
+          def string_value: -> (String | nil)
+
           def to_s: -> String
           def format_numeric_value: (Integer | Float) -> String
         end

data/sig/mindee/v2/parsing/search/model_webhook.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/v2/parsing/search/model_webhook.rb
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        class ModelWebhook
+          attr_reader id: String
+          attr_reader name: String
+          attr_reader url: String
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/search/search_model.rbs

@@ -8,6 +8,7 @@ module Mindee
           attr_reader id: String
           attr_reader model_type: String
           attr_reader name: String
+          attr_reader webhooks: Array[ModelWebhook]
 
           def initialize: (Hash[String|Symbol, untyped]) -> void
 

data/sig/mindee/v2/product/classification/classification_classifier.rbs

@@ -6,6 +6,7 @@ module Mindee
       module Classification
         class ClassificationClassifier
           attr_reader document_type: String
+          attr_reader extraction_response: Extraction::ExtractionResponse
 
           def initialize: (Hash[String | Symbol, untyped]) -> void
         end

data/sig/mindee/v2/product/crop/crop_item.rbs

@@ -3,8 +3,9 @@ module Mindee
     module Product
       module Crop
         class CropItem
+          attr_reader extraction_response: Extraction::ExtractionResponse
           attr_reader object_type: String
-          attr_reader location: Mindee::V2::Parsing::Field::FieldLocation
+          attr_reader location: Parsing::Field::FieldLocation
 
           def initialize: (Hash[String | Symbol, untyped]) -> void
 

data/sig/mindee/v2/product/split/split_range.rbs

@@ -3,6 +3,7 @@ module Mindee
     module Product
       module Split
         class SplitRange
+          attr_reader extraction_response: Extraction::ExtractionResponse
           attr_reader page_range: Array[Integer]
           attr_reader document_type: String
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -430,6 +430,7 @@ files:
 - lib/mindee/v2/parsing/raw_text.rb
 - lib/mindee/v2/parsing/raw_text_page.rb
 - lib/mindee/v2/parsing/search.rb
+- lib/mindee/v2/parsing/search/model_webhook.rb
 - lib/mindee/v2/parsing/search/pagination_metadata.rb
 - lib/mindee/v2/parsing/search/search_model.rb
 - lib/mindee/v2/parsing/search/search_models.rb
@@ -648,6 +649,7 @@ files:
 - sig/mindee/v2/parsing/rag_metadata.rbs
 - sig/mindee/v2/parsing/raw_text.rbs
 - sig/mindee/v2/parsing/raw_text_page.rbs
+- sig/mindee/v2/parsing/search/model_webhook.rbs
 - sig/mindee/v2/parsing/search/pagination_metadata.rbs
 - sig/mindee/v2/parsing/search/search_model.rbs
 - sig/mindee/v2/parsing/search/search_response.rbs