mindee 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0a25a68b96ba432920774b10de815c3dbf89386d9e74ea22b13fc36535e50a
-  data.tar.gz: a4f6f9d5da64be2c83ecdd32fdc6f8322998c470c1f94a099dff417ac9419671
+  metadata.gz: 9c6039978a362b6a5faab3b92fb4ef24fd9cbf85060f66614b007b371d851843
+  data.tar.gz: 4aa9ef461ee5fcc19f483dde6f584c583390e53ebba1889d5283b1864a26169c
 SHA512:
-  metadata.gz: f7af6e145ded009966a409c35bc7058158532cee1cc927486b1b05a003a3c8238968305ee4e546cc354abb3b78a5bc45caf4379b1e586bdcf61d800a766368b6
-  data.tar.gz: 591c6e87b9fcdc25b88bf3da8f6fd38c950fb9b03c6aeb096a14bc1f0da9dbf458c7445f137cbc27cef823126472b03653960ba741ea30083642da443f9f523a
+  metadata.gz: 226aa7601ad8b1a80dc6fb1071ad655a9aae647d70118184d0ada431b314503eb3f6157abdc59eb0205e157c3d7d8cc501ceb26258690ed9ad038b4d41336f93
+  data.tar.gz: a1d215cb0834ded50c9bcb913d2cf074d7e711ec73aaa67380705c71d51e29b6c15a162fa7afcadcab027954831155fdf065563cee1ce2aa0a7b300359cd7421

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Mindee Ruby API Library Changelog
 
+## v3.3.1 - 2023-12-15
+### Changes
+* :recycle: tweak async delays & retry
+* :recycle: tweak default async sample delays & retry
+* :memo: update md doc & fix typos
+
+
 ## v3.3.0 - 2023-11-17
 ### Changes
 * :sparkles: add support for Carte Grise V1

data/docs/bank_account_details_v2.md

@@ -81,7 +81,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/bank_check_v1.md

@@ -81,7 +81,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -170,7 +170,10 @@ puts result.document.inference.prediction.routing_number.value
 ```rb
 for page in result.document.inference.pages do
   for signatures_positions_elem in page.prediction.signatures_positions do
-    puts signatures_positions_elem.polygon
+    puts signatures_positions_elem.polygon.to_s
+    puts signatures_positions_elem.quadrangle.to_s
+    puts signatures_positions_elem.rectangle.to_s
+    puts signatures_positions_elem.boundingBox.to_s
   end
 end
 ```

data/docs/barcode_reader_v1.md

@@ -71,7 +71,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/carte_grise_v1.md

@@ -147,7 +147,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/carte_vitale_v1.md

@@ -73,7 +73,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/cropper_v1.md

@@ -64,7 +64,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -88,7 +88,10 @@ The following fields are extracted for Cropper V1:
 ```rb
 for page in result.document.inference.pages do
   for cropping_elem in page.prediction.cropping do
-    puts cropping_elem.polygon
+    puts cropping_elem.polygon.to_s
+    puts cropping_elem.quadrangle.to_s
+    puts cropping_elem.rectangle.to_s
+    puts cropping_elem.boundingBox.to_s
   end
 end
 ```

data/docs/expense_receipts_v5.md

@@ -119,7 +119,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -263,7 +263,7 @@ puts result.document.inference.prediction.supplier_phone_number.value
 
 ```rb
 for taxes_elem in result.document.inference.prediction.taxes do
-  puts taxes_elem.to_s
+  puts taxes_elem.value
 end
 ```
 

data/docs/financial_document_v1.md

@@ -131,7 +131,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -326,6 +326,9 @@ puts result.document.inference.prediction.supplier_name.value
 ```rb
 for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
   puts supplier_payment_details_elem.value
+    puts supplier_payment_details_elem.rate
+    puts supplier_payment_details_elem.code
+    puts supplier_payment_details_elem.basis
 end
 ```
 
@@ -341,7 +344,7 @@ puts result.document.inference.prediction.supplier_phone_number.value
 
 ```rb
 for taxes_elem in result.document.inference.prediction.taxes do
-  puts taxes_elem.to_s
+  puts taxes_elem.value
 end
 ```
 

data/docs/idcard_fr_v2.md

@@ -99,7 +99,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/invoices_v4.md

@@ -127,7 +127,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -308,6 +308,9 @@ puts result.document.inference.prediction.supplier_name.value
 ```rb
 for supplier_payment_details_elem in result.document.inference.prediction.supplier_payment_details do
   puts supplier_payment_details_elem.value
+    puts supplier_payment_details_elem.rate
+    puts supplier_payment_details_elem.code
+    puts supplier_payment_details_elem.basis
 end
 ```
 
@@ -316,7 +319,7 @@ end
 
 ```rb
 for taxes_elem in result.document.inference.prediction.taxes do
-  puts taxes_elem.to_s
+  puts taxes_elem.value
 end
 ```
 

data/docs/license_plates_v1.md

@@ -67,7 +67,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/multi_receipts_detector_v1.md

@@ -77,7 +77,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.
@@ -97,7 +97,10 @@ The following fields are extracted for Multi Receipts Detector V1:
 
 ```rb
 for receipts_elem in result.document.inference.prediction.receipts do
-  puts receipts_elem.polygon
+  puts receipts_elem.polygon.to_s
+    puts receipts_elem.quadrangle.to_s
+    puts receipts_elem.rectangle.to_s
+    puts receipts_elem.boundingBox.to_s
 end
 ```
 

data/docs/passport_v1.md

@@ -87,7 +87,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/proof_of_address_v1.md

@@ -105,7 +105,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/us_driver_license_v1.md

@@ -101,7 +101,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/docs/us_w9_v1.md

@@ -74,7 +74,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
+* **reconstructed** (`Boolean`): 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.

data/lib/mindee/client.rb

@@ -137,9 +137,9 @@ module Mindee
     #  * `:on_min_pages` Apply the operation only if document has at least this many pages.
     # @param cropper [Boolean, nil] Whether to include cropper results for each page.
     #  This performs a cropping operation on the server and will increase response time.
-    # @param initial_delay_sec [Integer, Float, nil] initial delay before polling. Defaults to 6.
-    # @param delay_sec [Integer, Float, nil] delay between polling attempts. Defaults to 3.
-    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 10.
+    # @param initial_delay_sec [Integer, Float, nil] initial delay before polling. Defaults to 4.
+    # @param delay_sec [Integer, Float, nil] delay between polling attempts. Defaults to 2.
+    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 30.
     # @return [Mindee::Parsing::Common::ApiResponse]
     def enqueue_and_parse(
       input_source,
@@ -149,9 +149,9 @@ module Mindee
       close_file: true,
       page_options: nil,
       cropper: false,
-      initial_delay_sec: 6,
-      delay_sec: 3,
-      max_retries: 10
+      initial_delay_sec: 4,
+      delay_sec: 2,
+      max_retries: 30
     )
       enqueue_res = enqueue(
         input_source,
@@ -243,11 +243,16 @@ module Mindee
     # Validates the parameters for async auto-polling
     # @param initial_delay_sec [Integer, Float] initial delay before polling
     # @param delay_sec [Integer, Float] delay between polling attempts
-    # @param max_retries [Integer, nil] maximum amount of retries. Defaults to 10.
+    # @param max_retries [Integer, nil] maximum amount of retries.
     def validate_async_params(initial_delay_sec, delay_sec, max_retries)
-      raise 'Cannot set auto-poll delay to less than 2 seconds' if delay_sec < 2
-      raise 'Cannot set initial parsing delay to less than 4 seconds' if initial_delay_sec < 4
-      raise 'Cannot set auto-poll delay to less than 2 seconds' unless max_retries.is_a? Integer
+      min_delay_sec = 1
+      min_initial_delay_sec = 2
+      min_retries = 2
+      raise "Cannot set auto-poll delay to less than #{min_delay_sec} seconds" if delay_sec < min_delay_sec
+      if initial_delay_sec < min_initial_delay_sec
+        raise "Cannot set initial parsing delay to less than #{min_initial_delay_sec} seconds"
+      end
+      raise "Cannot set auto-poll delay to less than #{min_retries} seconds" if max_retries < min_retries
     end
 
     # Creates an endpoint with the given values. Raises an error if the endpoint is invalid.

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel