RubyGems - mindee - Versions diffs - 4.0.0 → 4.1.2 - Mend

mindee 4.0.0 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (116) hide show

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: prism
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.1
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.1
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -134,56 +134,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: '1.70'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: '1.70'
 - !ruby/object:Gem::Dependency
   name: steep
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
+        version: '0.9'
 description: Quickly and easily connect to Mindee's API services using Ruby.
 email:
 - opensource@mindee.co
@@ -206,6 +206,7 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- bin/cli_products.rb
 - bin/console
 - bin/mindee.rb
 - docs/advanced_file_operations.md
@@ -235,7 +236,6 @@ files:
 - docs/code_samples/invoice_splitter_v1_async.txt
 - docs/code_samples/invoices_v4.txt
 - docs/code_samples/invoices_v4_async.txt
-- docs/code_samples/license_plates_v1.txt
 - docs/code_samples/multi_receipts_detector_v1.txt
 - docs/code_samples/nutrition_facts_v1_async.txt
 - docs/code_samples/passport_v1.txt
@@ -243,8 +243,10 @@ files:
 - docs/code_samples/payslip_fra_v3_async.txt
 - docs/code_samples/resume_v1_async.txt
 - docs/code_samples/us_healthcare_cards_v1_async.txt
+- docs/code_samples/us_mail_v2_async.txt
 - docs/code_samples/us_mail_v3_async.txt
 - docs/code_samples/us_w9_v1.txt
+- docs/code_samples/workflow_execution.txt
 - docs/getting_started.md
 - docs/global_products.md
 - docs/global_products/barcode_reader_v1.md
@@ -273,7 +275,6 @@ files:
 - docs/localized_products/french_healthcard_v1.md
 - docs/localized_products/idcard_fr_v2.md
 - docs/localized_products/ind_passport_v1.md
-- docs/localized_products/license_plates_v1.md
 - docs/localized_products/payslip_fra_v3.md
 - docs/localized_products/us_healthcare_cards_v1.md
 - docs/localized_products/us_mail_v3.md
@@ -387,9 +388,6 @@ files:
 - lib/mindee/product/driver_license/driver_license_v1.rb
 - lib/mindee/product/driver_license/driver_license_v1_document.rb
 - lib/mindee/product/driver_license/driver_license_v1_page.rb
-- lib/mindee/product/eu/license_plate/license_plate_v1.rb
-- lib/mindee/product/eu/license_plate/license_plate_v1_document.rb
-- lib/mindee/product/eu/license_plate/license_plate_v1_page.rb
 - lib/mindee/product/financial_document/financial_document_v1.rb
 - lib/mindee/product/financial_document/financial_document_v1_document.rb
 - lib/mindee/product/financial_document/financial_document_v1_line_item.rb
@@ -469,6 +467,8 @@ files:
 - lib/mindee/product/invoice/invoice_v4_page.rb
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb
+- lib/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rb
+- lib/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb
 - lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb
 - lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb
 - lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb
@@ -523,6 +523,12 @@ files:
 - lib/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rb
 - lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb
 - lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb
+- lib/mindee/product/us/us_mail/us_mail_v2.rb
+- lib/mindee/product/us/us_mail/us_mail_v2_document.rb
+- lib/mindee/product/us/us_mail/us_mail_v2_page.rb
+- lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb
+- lib/mindee/product/us/us_mail/us_mail_v2_recipient_addresses.rb
+- lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb
 - lib/mindee/product/us/us_mail/us_mail_v3.rb
 - lib/mindee/product/us/us_mail/us_mail_v3_document.rb
 - lib/mindee/product/us/us_mail/us_mail_v3_page.rb
@@ -627,9 +633,6 @@ files:
 - sig/mindee/product/driver_license/driver_license_v1.rbs
 - sig/mindee/product/driver_license/driver_license_v1_document.rbs
 - sig/mindee/product/driver_license/driver_license_v1_page.rbs
-- sig/mindee/product/eu/license_plate/license_plate_v1.rbs
-- sig/mindee/product/eu/license_plate/license_plate_v1_document.rbs
-- sig/mindee/product/eu/license_plate/license_plate_v1_page.rbs
 - sig/mindee/product/financial_document/financial_document_v1.rbs
 - sig/mindee/product/financial_document/financial_document_v1_document.rbs
 - sig/mindee/product/financial_document/financial_document_v1_line_item.rbs
@@ -709,6 +712,8 @@ files:
 - sig/mindee/product/invoice/invoice_v4_page.rbs
 - sig/mindee/product/invoice_splitter/invoice_splitter_v1.rbs
 - sig/mindee/product/invoice_splitter/invoice_splitter_v1_document.rbs
+- sig/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rbs
+- sig/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rbs
 - sig/mindee/product/invoice_splitter/invoice_splitter_v1_page.rbs
 - sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rbs
 - sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rbs
@@ -763,6 +768,12 @@ files:
 - sig/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rbs
 - sig/mindee/product/us/healthcare_card/healthcare_card_v1_document.rbs
 - sig/mindee/product/us/healthcare_card/healthcare_card_v1_page.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2_document.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2_page.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2_recipient_address.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2_recipient_addresses.rbs
+- sig/mindee/product/us/us_mail/us_mail_v2_sender_address.rbs
 - sig/mindee/product/us/us_mail/us_mail_v3.rbs
 - sig/mindee/product/us/us_mail/us_mail_v3_document.rbs
 - sig/mindee/product/us/us_mail/us_mail_v3_page.rbs

data/docs/localized_products/license_plates_v1.md DELETED Viewed

@@ -1,112 +0,0 @@
----
-title: Ruby Client Library - EU License Plate
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-eu-license-plate-ocr
-parentDoc: 67b49e29a2cd6f08d69a40d8
----
-The Ruby Client Library supports the [License Plate API](https://platform.mindee.com/mindee/license_plates).
-> 📝 Product Specs
->
-> | Specification                  | Details                                            |
-> | ------------------------------ | -------------------------------------------------- |
-> | Endpoint Name                  | `license_plates`                                   |
-> | Recommended Version            | `v1.1`                                             |
-> | Supports Polling/Webhooks      | ❌ No                                              |
-> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
-> | Geography                      | 🇪🇺 Europe                                          |
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/default_sample.jpg),
-we are going to illustrate how to extract the data that we want using the Ruby Client Library.
-![License Plate sample](https://github.com/mindee/client-lib-test-data/blob/main/products/license_plates/default_sample.jpg?raw=true)
-# Quick-Start
-```rb
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-require 'mindee'
-# Init a new client
-mindee_client = Mindee::Client.new(api_key: 'my-api-key')
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::EU::LicensePlate::LicensePlateV1
-)
-# Print a full summary of the parsed data in RST format
-puts result.document
-# Print the document-level parsed data
-# puts result.document.inference.prediction
-```
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: f0f48232-2c80-4473-9c6f-88a09111b84d
-:Filename: default_sample.jpg
-Inference
-#########
-:Product: mindee/license_plates v1.0
-:Rotation applied: No
-Prediction
-==========
-:License Plates: BY-323-YB
-Page Predictions
-================
-Page 0
-------
-:License Plates: BY-323-YB
-```
-# Field Types
-## Standard Fields
-These fields are generic and used in several products.
-### Basic Field
-Each prediction object contains a set of fields that inherit from the generic `Field` class.
-A typical `Field` object will have the following attributes:
-* **value** (`String`, `Float`, `Integer`, `bool`): corresponds to the field value. Can be `nil` if no value was extracted.
-* **confidence** (Float, nil): the confidence score of the field prediction.
-* **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
-* **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
-* **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
-Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
-### String Field
-The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
-# Attributes
-The following fields are extracted for License Plate V1:
-## License Plates
-**license_plates** (Array<[StringField](#string-field)>): List of all license plates found in the image.
-```rb
-result.document.inference.prediction.license_plates do |license_plates_elem|
-  puts license_plates_elem.value
-end
-```
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/lib/mindee/product/eu/license_plate/license_plate_v1_document.rb DELETED Viewed

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-require_relative '../../../parsing'
-module Mindee
-  module Product
-    module EU
-      module LicensePlate
-        # License Plate API version 1.1 document data.
-        class LicensePlateV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # List of all license plates found in the image.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :license_plates
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @license_plates = [] # : Array[Parsing::Standard::StringField]
-            prediction['license_plates'].each do |item|
-              @license_plates.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-          end
-          # @return [String]
-          def to_s
-            license_plates = @license_plates.join("\n #{' ' * 16}")
-            out_str = String.new
-            out_str << "\n:License Plates: #{license_plates}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/eu/license_plate/license_plate_v1.rbs DELETED Viewed

@@ -1,13 +0,0 @@
-# lib/mindee/product/../license_plate/license_plate_v1.rb
-module Mindee
-  module Product
-    module EU
-      module LicensePlate
-        class LicensePlateV1 < Parsing::Common::Inference
-          def initialize: (Hash[Symbol | String, untyped]) -> void
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/eu/license_plate/license_plate_v1_document.rbs DELETED Viewed

@@ -1,15 +0,0 @@
-# lib/mindee/product/../license_plate/license_plate_v1_document.rb
-module Mindee
-  module Product
-    module EU
-      module LicensePlate
-        class LicensePlateV1Document < Parsing::Common::Prediction
-          def initialize: (Hash[Symbol | String, untyped], Integer?) -> void
-          def license_plates: -> (Array[Parsing::Standard::StringField])
-          def to_s: -> String
-        end
-      end
-    end
-  end
-end