mindee 3.12.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef77c472e79a3139844c6e719cb368c081466ceed4ded849a39eefb27484ca78
-  data.tar.gz: 4d41a61f23ccad56d6f9e4a846feed4c67c613d17a80baf0191aec119eb0835a
+  metadata.gz: '043953eb35ed9f251d12ca8b984edcf9acbeb491689574450dc3682b83e9db37'
+  data.tar.gz: 5916ad8aeada6713ee5a846d634693fd1ed5e585495238649f9a9c1d2e9fbd00
 SHA512:
-  metadata.gz: df1777eaec4a97d7524e0bf0cc3e2356169a9a62af6349a10abacc8d1977c83124cbdeafed2e1d94f4cef4e3986c5e488fea45c31c1048c3feed85cdc8e0fb74
-  data.tar.gz: 998987a5877b57d1ef2fc078c144f247369c2824b5a84334297e2bed81e61a77b894a863d5a4920d23cb3093b18f86bb0201b7e51a971136f3c2c1bb33c065ea
+  metadata.gz: 7edd036d9666e1ffe0318b8ec68cdfe5b37b6bdbb90e36ae0c19efa5cc038f109af30d9e6df6838e4237db2f9495a6251f10164db7e0c7dff528720ef4477a2a
+  data.tar.gz: 7dfbb27c5175bda760ba816be62b1447acf4517d6741506cb458bbe4b2b4c77338eff1d799d19f4b0bdca663323523eb479bc468e80f9ed1943226694ef04143

data/.rubocop.yml

@@ -38,7 +38,7 @@ Metrics/ClassLength:
   Max: 200
 
 Metrics/ParameterLists:
-  Max: 7
+  Max: 8
 
 Metrics/AbcSize:
   Max: 60

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Mindee Ruby API Library Changelog
 
+## v3.14.0 - 2024-10-11
+### Changes
+* :sparkles: add support for Financial Document v1.10
+* :sparkles: add support for Invoice v4.8
+### Fixes
+* :bug: fix multi-receipts extraction not working as intended
+
+
+## v3.13.0 - 2024-09-18
+### Changes
+* :sparkles: add support for BillOfLadingV1
+* :sparkles: add support for (US) UsMailV2
+* :sparkles: add support for (FR) EnergyBillV1
+* :sparkles: add support for (FR) PayslipV1
+* :sparkles: add support for NutritionFactsLabelV1
+* :sparkles: add support for cropper Extra
+* :sparkles: add support for full text Extra
+* :sparkles: add support for invoice splitter auto-extraction
+
+### Fixes
+* :bug: fixed a bug that prevented longer decimals from appearing in the string representation of some objects
+* :bug: fixed a bug that caused non-table elements to unexpectedly appear truncated when printed to the console
+* :memo: fix a few documentation errors & typos
+* :wrench: updated CI dependencies
+
+
 ## v3.12.0 - 2024-07-24
 ### Changes
 * :sparkles: add support for Multi-Receipts Extraction

data/README.md

@@ -167,29 +167,29 @@ bundle exec ruby ./bin/mindee.rb invoice path/to/your/file.ext
 There's more to it than that for those that need more features, or want to
 customize the experience.
 
-* [Ruby Overview](https://developers.mindee.com/docs/getting-started-ocr-ruby)
-* [Custom OCR Ruby](https://developers.mindee.com/docs/api-builder-ocr-ruby)
-* [Generated API Ruby](https://developers.mindee.com/docs/generated-api-ruby)
-* [Invoice OCR Ruby](https://developers.mindee.com/docs/invoice-ocr-ruby)
-* [International Id OCR Ruby](https://developers.mindee.com/docs/international-id-ocr-ruby)
-* [Financial Document OCR Ruby](https://developers.mindee.com/docs/financial-document-ocr-ruby)
-* [Passport OCR Ruby](https://developers.mindee.com/docs/passport-ocr-ruby)
-* [Proof of Address OCR Ruby](https://developers.mindee.com/docs/proof-of-address-ocr-ruby)
-* [Receipt OCR Ruby](https://developers.mindee.com/docs/receipt-ocr-ruby)
-* [Resume OCR Ruby](https://developers.mindee.com/docs/resume-ocr-ruby)
-* [EU License Plate OCR Ruby](https://developers.mindee.com/docs/eu-license-plate-ocr-ruby)
-* [EU Driver License OCR Ruby](https://developers.mindee.com/docs/eu-driver-license-ocr-ruby)
-* [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/fr-bank-account-details-ocr-ruby)
-* [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/fr-bank-statement-ocr-ruby)
-* [FR Carte Vitale OCR Ruby](https://developers.mindee.com/docs/fr-carte-vitale-ocr-ruby)
-* [FR ID Card OCR Ruby](https://developers.mindee.com/docs/fr-id-card-ocr-ruby)
-* [US Bank Check OCR Ruby](https://developers.mindee.com/docs/us-bank-check-ocr-ruby)
-* [US Driver License OCR Ruby](https://developers.mindee.com/docs/us-driver-license-ocr-ruby)
-* [US W9 API Ruby](https://developers.mindee.com/docs/us-w9-api-ruby)
-* [Barcode Reader API Ruby](https://developers.mindee.com/docs/barcode-reader-api-ruby)
-* [Cropper API Ruby](https://developers.mindee.com/docs/cropper-api-ruby)
-* [Invoice Splitter API Ruby](https://developers.mindee.com/docs/invoice-splitter-api-ruby)
-* [Multi Receipts Detector API Ruby](https://developers.mindee.com/docs/multi-receipts-detector-api-ruby)
+* [Ruby Overview](https://developers.mindee.com/docs/ruby-getting-started)
+* [Custom OCR Ruby (Deprecated)](https://developers.mindee.com/docs/ruby-api-builder-ocr)
+* [Generated API Ruby](https://developers.mindee.com/docs/ruby-generated-ocr)
+* [Invoice OCR Ruby](https://developers.mindee.com/docs/ruby-invoice-ocr)
+* [International Id OCR Ruby](https://developers.mindee.com/docs/ruby-international-id-ocr)
+* [Financial Document OCR Ruby](https://developers.mindee.com/docs/ruby-financial-document-ocr)
+* [Passport OCR Ruby](https://developers.mindee.com/docs/ruby-passport-ocr)
+* [Proof of Address OCR Ruby](https://developers.mindee.com/docs/ruby-proof-of-address-ocr)
+* [Receipt OCR Ruby](https://developers.mindee.com/docs/ruby-receipt-ocr)
+* [Resume OCR Ruby](https://developers.mindee.com/docs/ruby-resume-ocr)
+* [EU License Plate OCR Ruby](https://developers.mindee.com/docs/ruby-eu-license-plate-ocr)
+* [EU Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-eu-driver-license-ocr)
+* [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-account-details-ocr)
+* [FR Bank Statement OCR Ruby](https://developers.mindee.com/docs/ruby-fr-bank-statement-ocr)
+* [FR Carte Vitale OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-vitale-ocr)
+* [FR ID Card OCR Ruby](https://developers.mindee.com/docs/ruby-fr-carte-nationale-didentite-ocr)
+* [US Bank Check OCR Ruby](https://developers.mindee.com/docs/ruby-us-bank-check-ocr)
+* [US Driver License OCR Ruby](https://developers.mindee.com/docs/ruby-us-driver-license-ocr)
+* [US W9 API Ruby](https://developers.mindee.com/docs/ruby-us-w9-ocr)
+* [Barcode Reader API Ruby](https://developers.mindee.com/docs/ruby-barcode-reader-ocr)
+* [Cropper API Ruby](https://developers.mindee.com/docs/ruby-cropper-ocr)
+* [Invoice Splitter API Ruby](https://developers.mindee.com/docs/ruby-invoice-splitter-ocr)
+* [Multi Receipts Detector API Ruby](https://developers.mindee.com/docs/ruby-multi-receipts-detector-ocr)
 
 You can also take a look at the
 [Reference Documentation](https://mindee.github.io/mindee-api-ruby/).

data/Rakefile

@@ -20,6 +20,11 @@ YARD::Rake::YardocTask.new(:doc) do |task|
   task.files = ['lib/**/*.rb']
 end
 
+desc 'Run integration tests'
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = 'spec/**/*_integration.rb'
+end
+
 Rake::Task[:doc].enhance do
   FileUtils.cp_r(
     File.join('docs', 'code_samples'),

data/docs/bank_account_details_v2.md

@@ -1,5 +1,8 @@
 ---
 title: FR Bank Account Details OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-bank-account-details-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Bank Account Details API](https://platform.mindee.com/mindee/bank_account_details).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -80,7 +84,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 

data/docs/bank_check_v1.md

@@ -1,5 +1,8 @@
 ---
 title: US Bank Check OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-us-bank-check-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Bank Check API](https://platform.mindee.com/mindee/bank_check).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -80,7 +84,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 
@@ -106,7 +110,7 @@ The position field `PositionField` does not implement all the basic `Field` attr
 The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Bank Check V1:

data/docs/bank_statement_fr_v1.md

@@ -1,5 +1,8 @@
 ---
 title: FR Bank Statement (FR) OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-bank-statement-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Bank Statement (FR) API](https://platform.mindee.com/mindee/bank_statement_fr).
 

data/docs/barcode_reader_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Barcode Reader OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-barcode-reader-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Barcode Reader API](https://platform.mindee.com/mindee/barcode_reader).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -70,7 +74,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 

data/docs/bill_of_lading_v1.md

@@ -0,0 +1,251 @@
+---
+title: Bill of Lading OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-bill-of-lading-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Bill of Lading API](https://platform.mindee.com/mindee/bill_of_lading).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Bill of Lading sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bill_of_lading/default_sample.jpg?raw=true)
+
+# Quick-Start
+```rb
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::BillOfLading::BillOfLadingV1
+)
+
+# 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: 3b5250a1-b52c-4e0b-bc3e-2f0146b04e29
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/bill_of_lading v1.1
+:Rotation applied: No
+
+Prediction
+==========
+:Bill of Lading Number: XYZ123456
+:Shipper:
+  :Address: 123 OCEAN DRIVE, SHANGHAI, CHINA
+  :Email:
+  :Name: GLOBAL FREIGHT SOLUTIONS INC.
+  :Phone: 86-21-12345678
+:Consignee:
+  :Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
+  :Email:
+  :Name: PACIFIC TRADING CO.
+  :Phone: 65-65432100
+:Notify Party:
+  :Address: 789 TRADE STREET, SINGAPORE 567890, SINGAPORE
+  :Email:
+  :Name: PACIFIC TRADING CO.
+  :Phone: 65-65432100
+:Carrier:
+  :Name: GLOBAL SHIPPING CO.,LTD.
+  :Professional Number:
+  :SCAC:
+:Items:
+  +--------------------------------------+--------------+-------------+------------------+----------+-------------+
+  | Description                          | Gross Weight | Measurement | Measurement Unit | Quantity | Weight Unit |
+  +======================================+==============+=============+==================+==========+=============+
+  | ELECTRONIC COMPONENTS\nP/N: 12345... | 500.00       | 1.50        | cbm              | 1.00     | kgs         |
+  +--------------------------------------+--------------+-------------+------------------+----------+-------------+
+:Port of Loading: SHANGHAI, CHINA
+:Port of Discharge: LOS ANGELES, USA
+:Place of Delivery: LOS ANGELES, USA
+:Date of issue: 2022-09-30
+:Departure Date:
+```
+
+# 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`, `Boolean`): 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** (`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.
+
+### Date Field
+Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+
+* **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
+
+### String Field
+The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Carrier Field
+The shipping company responsible for transporting the goods.
+
+A `BillOfLadingV1Carrier` implements the following attributes:
+
+* `name` (String): The name of the carrier.
+* `professional_number` (String): The professional number of the carrier.
+* `scac` (String): The Standard Carrier Alpha Code (SCAC) of the carrier.
+Fields which are specific to this product; they are not used in any other product.
+
+### Consignee Field
+The party to whom the goods are being shipped.
+
+A `BillOfLadingV1Consignee` implements the following attributes:
+
+* `address` (String): The address of the consignee.
+* `email` (String): The  email of the shipper.
+* `name` (String): The name of the consignee.
+* `phone` (String): The phone number of the consignee.
+Fields which are specific to this product; they are not used in any other product.
+
+### Items Field
+The goods being shipped.
+
+A `BillOfLadingV1CarrierItem` implements the following attributes:
+
+* `description` (String): A description of the item.
+* `gross_weight` (Float): The gross weight of the item.
+* `measurement` (Float): The measurement of the item.
+* `measurement_unit` (String): The unit of measurement for the measurement.
+* `quantity` (Float): The quantity of the item being shipped.
+* `weight_unit` (String): The unit of measurement for weights.
+Fields which are specific to this product; they are not used in any other product.
+
+### Notify Party Field
+The party to be notified of the arrival of the goods.
+
+A `BillOfLadingV1NotifyParty` implements the following attributes:
+
+* `address` (String): The address of the notify party.
+* `email` (String): The  email of the shipper.
+* `name` (String): The name of the notify party.
+* `phone` (String): The phone number of the notify party.
+Fields which are specific to this product; they are not used in any other product.
+
+### Shipper Field
+The party responsible for shipping the goods.
+
+A `BillOfLadingV1Shipper` implements the following attributes:
+
+* `address` (String): The address of the shipper.
+* `email` (String): The  email of the shipper.
+* `name` (String): The name of the shipper.
+* `phone` (String): The phone number of the shipper.
+
+# Attributes
+The following fields are extracted for Bill of Lading V1:
+
+## Bill of Lading Number
+**bill_of_lading_number** ([StringField](#string-field)): A unique identifier assigned to a Bill of Lading document.
+
+```rb
+puts result.document.inference.prediction.bill_of_lading_number.value
+```
+
+## Carrier
+**carrier** ([BillOfLadingV1Carrier](#carrier-field)): The shipping company responsible for transporting the goods.
+
+```rb
+puts result.document.inference.prediction.carrier.value
+```
+
+## Items
+**carrier_items** (Array<[BillOfLadingV1CarrierItem](#items-field)>): The goods being shipped.
+
+```rb
+for carrier_items_elem in result.document.inference.prediction.carrier_items do
+  puts carrier_items_elem.value
+end
+```
+
+## Consignee
+**consignee** ([BillOfLadingV1Consignee](#consignee-field)): The party to whom the goods are being shipped.
+
+```rb
+puts result.document.inference.prediction.consignee.value
+```
+
+## Date of issue
+**date_of_issue** ([DateField](#date-field)): The date when the bill of lading is issued.
+
+```rb
+puts result.document.inference.prediction.date_of_issue.value
+```
+
+## Departure Date
+**departure_date** ([DateField](#date-field)): The date when the vessel departs from the port of loading.
+
+```rb
+puts result.document.inference.prediction.departure_date.value
+```
+
+## Notify Party
+**notify_party** ([BillOfLadingV1NotifyParty](#notify-party-field)): The party to be notified of the arrival of the goods.
+
+```rb
+puts result.document.inference.prediction.notify_party.value
+```
+
+## Place of Delivery
+**place_of_delivery** ([StringField](#string-field)): The place where the goods are to be delivered.
+
+```rb
+puts result.document.inference.prediction.place_of_delivery.value
+```
+
+## Port of Discharge
+**port_of_discharge** ([StringField](#string-field)): The port where the goods are unloaded from the vessel.
+
+```rb
+puts result.document.inference.prediction.port_of_discharge.value
+```
+
+## Port of Loading
+**port_of_loading** ([StringField](#string-field)): The port where the goods are loaded onto the vessel.
+
+```rb
+puts result.document.inference.prediction.port_of_loading.value
+```
+
+## Shipper
+**shipper** ([BillOfLadingV1Shipper](#shipper-field)): The party responsible for shipping the goods.
+
+```rb
+puts result.document.inference.prediction.shipper.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/carte_grise_v1.md

@@ -1,5 +1,8 @@
 ---
 title: FR Carte Grise OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-carte-grise-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Carte Grise API](https://platform.mindee.com/mindee/carte_grise).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -146,7 +150,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 

data/docs/carte_vitale_v1.md

@@ -1,5 +1,8 @@
 ---
 title: FR Carte Vitale OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-carte-vitale-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Carte Vitale API](https://platform.mindee.com/mindee/carte_vitale).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -72,7 +76,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 

data/docs/code_samples/bill_of_lading_v1_async.txt

@@ -0,0 +1,19 @@
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::BillOfLading::BillOfLadingV1
+)
+
+# 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

data/docs/code_samples/energy_bill_fra_v1_async.txt

@@ -0,0 +1,19 @@
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::FR::EnergyBill::EnergyBillV1
+)
+
+# 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

data/docs/code_samples/invoices_v4_async.txt

@@ -0,0 +1,19 @@
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::Invoice::InvoiceV4
+)
+
+# 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

data/docs/code_samples/nutrition_facts_v1_async.txt

@@ -0,0 +1,19 @@
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1
+)
+
+# 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

data/docs/code_samples/payslip_fra_v2_async.txt

@@ -0,0 +1,19 @@
+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.enqueue_and_parse(
+  input_source,
+  Mindee::Product::FR::Payslip::PayslipV2
+)
+
+# 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

data/docs/cropper_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Cropper OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-cropper-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Cropper API](https://platform.mindee.com/mindee/cropper).
 
@@ -24,6 +27,7 @@ result = mindee_client.parse(
 
 # Print a full summary of the parsed data in RST format
 puts result.document
+
 ```
 
 **Output (RST):**
@@ -63,7 +67,7 @@ A typical `Field` object will have the following attributes:
 * **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, is `nil` when at document-level.
+* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
 * **reconstructed** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
 
 
@@ -77,7 +81,7 @@ The position field `PositionField` does not implement all the basic `Field` attr
 * **quadrangle** (`Mindee::Geometry::Quadrilateral`): a free polygon made up of four points.
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Cropper V1: