mindee-lite 5.0.0.rc1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3f594fd19a65af160aa57c2be44b60a512671b2e73492520eee97c28cbaa64
-  data.tar.gz: fe9fa1d790baa59e5c8724bcd044470989b1b53fb01a1c3d97837a4aefaf107e
+  metadata.gz: 4e134080cbd8093de8ce96f6fbcdd9cf2bf053637e9c35cc4e141feb1d1114b2
+  data.tar.gz: a97c1266cde82d49f8fa209fa74cd370ed6da523a1f67e12f2c4f18f4cdc27bc
 SHA512:
-  metadata.gz: aae1932c173406f33a3afbe76181324bb6573f23afed02e4ae3f883fa346b3f0f543612f650682a03ddbbc88dbef6ef1e38f4ee555ec38a642ee9645613366de
-  data.tar.gz: e02b2e5c32354e4ddd98c9bc75ce8a2ffe89894fb611015840f5d8d2a11248ef1963c733ff76918604d9fc6ccc31e695b83985a54db1bcfb410b7c26cd46e601
+  metadata.gz: 2d3cbcb02edb9ef33a327b660c073fa926d76d85ca4a46af7ee21c8e10ac9c4086dbf4b85c82918bf676649f38e56b785cddaaa58dce3c32c8dada4330af23be
+  data.tar.gz: c542570b0402468b1882739d33fcca7a2ecc1d98ca2deda95a92d41b4c3576bfaf8f1f3c721d3c29a7618fba0716ab8551190a1576d360341e103808c81bd9a2

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Mindee Ruby API Library Changelog
 
+## 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
+    * :recycle: move V1 client to V1 module
+    * :recycle: move V2 client to V2 module
+    * :recycle: move legacy products to 'V1' module
+    * :recycle: add parsing and extraction to v1 module
+    * :recycle: move V1 HTTP to V1 module
+    * :recycle: move V2 HTTP module to V2 namespace
+    * :recycle: move data schema to extraction parameters namespace
+* :arrow_up: :boom: drop support for ruby < 3.2
+* :recycle: :boom: change raw_http attribute in responses to be actual json strings
+* :recycle: :boom: make logging configurable and default output to stderr
+* :recycle: :boom: remove useless `PDFExtractor` module
+* :recycle: :boom: change `Errors` module to `Error`
+* :recycle: :boom: change Ocr modules and classes to OCR to keep consistency
+* :recycle: :boom: change `FileOperation` module name to `FileOperations`
+* :recycle: :boom: change `Dependency` module name to `Dependencies`
+* :boom: remove support for the following V1 products:
+    * :coffin: US Bank Check V1
+    * :coffin: Bill of Lading V1
+    * :coffin: Business Card V1
+    * :coffin: FR Carte Grise V1
+    * :coffin: Delivery Notes V1
+    * :coffin: Driver License V1
+    * :coffin: FR Energy Bill V1
+    * :coffin: Nutrition Facts V1
+### Changes
+* :sparkles: :arrow_up: add support for mindee-lite gem
+* :sparkles: add support for crop operation
+* :sparkles: add support for split operation
+* :sparkles: add support for model search
+* :sparkles: add support for V2 CLI
+* :wrench: :arrow_up: add better tooling and pre-commit hook
+* :arrow_up: and bump all dependencies
+### Fixes
+* :wrench: fix many typing issues
+* :bug: fix webhook IDs not sending properly
+* :bug: fix miscellaneous issues leading to saved `ExtractedPDF` instances having invalid names
+* :recycle: fix miscellaneous typing issues relating to `ExtractedPDF` and `ExtractedImage` classes
+
+
 ## v5.0.0.rc1 - 2026-04-15
 ### ¡Breaking Changes!
 * :recycle: :boom: change `FileOperation` module name to `FileOperations`

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/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.rc1'
+  VERSION = '5.1.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/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-lite
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.1.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -589,9 +589,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.19
 signing_key: