mindee 3.20.0 → 4.0.0

data/docs/getting_started.md

@@ -1,5 +1,5 @@
 ---
-title: Ruby Getting Started
+title: Getting Started
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-getting-started
 parentDoc: 6294d97ee723f1008d2ab28e
@@ -9,10 +9,10 @@ This guide will help you get the most out of the Mindee Ruby client library to e
 ## Installation
 
 ### Requirements
-The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1, 3.2
+The following Ruby versions are tested and supported: 3.0, 3.1, 3.2, 3.3
 
 ### Standard Installation
-To quickly get started with the Ruby OCR SDK, Install by adding this line to your application's Gemfile:
+To quickly get started with the Ruby Client Library, Install by adding this line to your application's Gemfile:
 
 ```shell
 gem 'mindee'
@@ -75,7 +75,8 @@ Using Mindee's APIs can be broken down into the following steps:
 Let's take a deep dive into how this works.
 
 ## Initializing the Client
-The `Client` automatically connects to the default endpoints for each product (or creates one with given parameters for Custom APIs).
+The `Client` automatically connects to the default endpoints for each product (or creates one with given parameters for
+Universal APIs).
 
 The `Client` requires your [API key](https://developers.mindee.com/docs/make-your-first-request#create-an-api-key).
 
@@ -83,7 +84,7 @@ You can either pass these directly to the constructor or through environment var
 
 
 ### Pass the API key directly
-```ruby
+```rb
 # Init a new client and passing the key directly
 mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 ```
@@ -97,7 +98,7 @@ MINDEE_API_KEY=my-api-key
 ```
  
 Then in your code:
-```ruby
+```rb
 # Init a new client without an API key
 mindee_client = Mindee::Client.new
 ```
@@ -118,86 +119,33 @@ all supported types automatically.
 Once a document is loaded, interacting with it is done in exactly the same way, regardless
 of how it was loaded.
 
-There are a few different ways of loading a document file, depending on your use case:
-
-* [Path](#path)
-* [File Object](#file-object)
-* [Base64](#base64)
-* [Bytes](#bytes)
-* [Urls](#url)
-
-### Path
-Load from a file directly from disk. Requires an absolute path, as a string.
-
-```ruby
-# 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::Invoice::InvoiceV4
-)
-# Print a full summary of the parsed data in RST format
-puts result.document
-```
-
-### File Object
-A normal Ruby file object with a path. Must be in binary mode.
+There are a few different ways of loading a document file, depending on your use case, you can use a:
 
-**Note**: The original filename is required when calling the method.
+* [File path](https://developers.mindee.com/docs/ruby-document-loading#loading-from-a-local-path): using the Mindee Client's `source_from_path()` method.
+* [File Object](https://developers.mindee.com/docs/ruby-document-loading#loading-from-a-file-object): using the Mindee Client's `source_from_file()` method.
+* [Base64 String](https://developers.mindee.com/docs/ruby-document-loading#loading-from-a-base64-encoded-string): using the Mindee Client's `source_from_b64string()` method.
+* [Raw Byte sequence](https://developers.mindee.com/docs/ruby-document-loading#loading-from-raw-bytes): using the Mindee Client's `source_from_bytes()` method.
+* [URL](https://developers.mindee.com/docs/ruby-document-loading#loading-by-url): using the Mindee Client's `source_from_url()` method.
 
-```ruby
-File.open(INVOICE_FILE, 'rb') do |fo|
-  input_source = mindee_client.source_from_file(fo, "invoice.jpg")
-end
+More details about file loading on the [dedicated page](https://developers.mindee.com/docs/ruby-document-loading).
 
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::Invoice::InvoiceV4
-)
-```
-
-### Base64
-Load file contents from a base64-encoded string.
-
-**Note**: The original filename is required when calling the method.
-
-```ruby
-b64_string = "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLD...."
-
-input_source = mindee_client.source_from_b64string(b64_string, "receipt.jpg")
-
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::Receipt::ReceiptV5
-)
-```
+## Sending a File
+To send a file to the API, we need to specify how to process the document.
+This will determine which API endpoint is used and how the API return will be handled internally by the library.
 
-### Bytes
-Requires raw bytes.
+More specifically, we need to set a `Mindee::Product` class as the first parameter of the `create_endpoint` method.
 
-**Note**: The original filename is required when calling the method.
+This is because the `Endpoint`'s urls will be set according to it
 
-```ruby
-raw_bytes = b"%PDF-1.3\n%\xbf\xf7\xa2\xfe\n1 0 ob..."
-input_source = mindee_client.source_from_bytes(raw_bytes, "invoice.pdf")
+Each document type available in the library has its corresponding class, which inherit from the base
+`Mindee::Parsing::Common::Predict` class.
 
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::Invoice::InvoiceV4
-)
-```
+This is detailed in each document-specific guide.
 
-### URL
-Requires an url as a String.
+### Off-the-Shelf Documents
+Simply setting the correct class is enough:
 
-**Note**: the url must start with `https://`.
-```ruby
-input_source = mindee_client.source_from_url("https://www.example.com/invoice.pdf")
+```rb
 
 result = mindee_client.parse(
   input_source,
@@ -205,44 +153,42 @@ result = mindee_client.parse(
 )
 ```
 
-## Sending a File
-To send a file to the API, we need to specify how to process the document.
-This will determine which API endpoint is used and how the API return will be handled internally by the library.
-
-More specifically, we need to set a `Mindee::Product` class as the first parameter of the `create_endpoint` method.
-
-This is because the `Endpoint`'s urls will be set according to it
-
-Each document type available in the library has its corresponding class, which inherit from the base `Mindee::Parsing::Common::Predict` class.
-This is detailed in each document-specific guide.
+#### Specific call method
+Some products, such as InvoiceV4, ReceiptV5 & FinancialDocumentV1 support both asynchronous polling and synchronous
+HTTP calls.
+We recommend letting the client library decide which is better by default, but you can override the behavior by setting
+the `enqueue` parameter to `true` or `false`.
 
-### Off-the-Shelf Documents
-Simply setting the correct class is enough:
-```ruby
+```rb
 
 result = mindee_client.parse(
   input_source,
-  Mindee::Product::Invoice::InvoiceV4
+  Mindee::Product::Invoice::InvoiceV4,
+  enqueue: false
 )
 ```
 
-### Custom Documents (docTI)
+> 🚧 WARNING: this feature is not available for all products, and may result in errors if used inappropriately.
+> Only use it if you are certain of what you are doing.
+### Universal Documents (docTI)
 For custom documents, the endpoint to use must also be set, and it must take in an `endpoint_name`:
 
-```ruby
+```rb
 endpoint = mindee_client.create_endpoint(endpoint_name: 'wnine', account_name: 'my-account')
 
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
-  Mindee::Product::Generated::GeneratedV1,
+  Mindee::Product::Universal::Universal,
   endpoint: endpoint
 )
 ```
 
-This is because the `GeneratedV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.
+This is because the `Universal` class is enough to handle the return processing, but the actual endpoint needs to be
+specified.
 
 ## Process the Result
-The response object is common to all documents, including custom documents. The main properties are:
+The response object is common to all documents, including custom documents (using the Universal product). The main
+properties are:
 
 * `id` — Mindee ID of the document
 * `name` — Filename sent to the API
@@ -261,7 +207,7 @@ It contains the data extracted from the entire document, all pages combined.
 It's possible to have the same field in various pages, but at the document level,
 only the highest confidence field data will be shown (this is all done automatically at the API level).
 
-```ruby
+```rb
 # as an object, complete
 pp result.document.inference.prediction
 
@@ -279,7 +225,7 @@ All response objects have this property, regardless of the number of pages.
 Single page documents will have a single entry.
 
 Iteration is done like any Ruby array:
-```ruby
+```rb
 response.document.inference.pages.each do |page|
     # as an object, complete
     pp page.prediction
@@ -290,36 +236,22 @@ end
 ```
 
 #### Page Orientation
-The orientation field is only available at the page level as it describes whether the page image should be rotated to be upright.
+The orientation field is only available at the page level as it describes whether the page image should be rotated to
+be upright.
 
-If the page requires rotation for correct display, the orientation field gives a prediction among these 3 possible outputs:
+If the page requires rotation for correct display, the orientation field gives a prediction among these 3 possible
+outputs:
 
 * 0 degrees: the page is already upright
 * 90 degrees: the page must be rotated clockwise to be upright
 * 270 degrees: the page must be rotated counterclockwise to be upright
 
-```ruby
+```rb
 response.document.inference.pages.each do |page|
   puts page.orientation.value
 end
 ```
 
-## 🧪 Experimental Features
-
-### PDF repair
-
-Some PDF files might appear fine on your computer, but can be rejected by the server.
-This _experimental_ feature attempts to fix the file's header information before sending it to the server.
-
-> ⚠️ **Warning**: This feature copies your file and then **alters** it. The original file will be left alone, but the copy might get partially corrupted, and improperly parsed as a result. Use at your own discretion.
-
-To enable it, simply set the `fix_pdf` flag to `true` during source creation:
-
-```rb
-input_source = mindee_client.source_from_file(input_file, "name-of-my-file.ext", fix_pdf: true)
-```
-
-Note: This only works for local files, files sent by URL will not be processed.
 
 ## Questions?
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/{barcode_reader_v1.md → global_products/barcode_reader_v1.md}

@@ -1,16 +1,34 @@
 ---
-title: Barcode Reader OCR Ruby
+title: Ruby Client Library - Barcode Reader
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-barcode-reader-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Barcode Reader API](https://platform.mindee.com/mindee/barcode_reader).
+The Ruby Client Library supports the [Barcode Reader API](https://platform.mindee.com/mindee/barcode_reader).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/barcode_reader/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `barcode_reader`                                   |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ❌ No                                              |
+> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
+> | Geography                      | 🌐 Global                                          |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/barcode_reader/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Barcode Reader sample](https://github.com/mindee/client-lib-test-data/blob/main/products/barcode_reader/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -30,7 +48,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -70,12 +87,12 @@ These fields are generic and used in several products.
 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.
+* **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** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **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.
@@ -90,7 +107,7 @@ The following fields are extracted for Barcode Reader V1:
 **codes_1d** (Array<[StringField](#string-field)>): List of decoded 1D barcodes.
 
 ```rb
-for codes_1d_elem in result.document.inference.prediction.codes_1d do
+result.document.inference.prediction.codes_1d do |codes_1d_elem|
   puts codes_1d_elem.value
 end
 ```
@@ -99,7 +116,7 @@ end
 **codes_2d** (Array<[StringField](#string-field)>): List of decoded 2D barcodes.
 
 ```rb
-for codes_2d_elem in result.document.inference.prediction.codes_2d do
+result.document.inference.prediction.codes_2d do |codes_2d_elem|
   puts codes_2d_elem.value
 end
 ```

data/docs/{bill_of_lading_v1.md → global_products/bill_of_lading_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: Bill of Lading OCR Ruby
+title: Ruby Client Library - Bill of Lading
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-bill-of-lading-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-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.
+The Ruby Client Library supports the [Bill of Lading API](https://platform.mindee.com/mindee/bill_of_lading).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `bill_of_lading`                                   |
+> | Recommended Version            | `v1.1`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+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 Ruby Client Library.
 ![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
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -20,7 +46,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::BillOfLading::BillOfLadingV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -89,18 +114,18 @@ These fields are generic and used in several products.
 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.
+* **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** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **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.
 
 ### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
+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.
 
@@ -110,14 +135,15 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 ## 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.
+### Shipper Field
+The party responsible for shipping the goods.
 
-A `BillOfLadingV1Carrier` implements the following attributes:
+A `BillOfLadingV1Shipper` 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.
+* `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.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Consignee Field
@@ -131,19 +157,6 @@ A `BillOfLadingV1Consignee` implements the following attributes:
 * `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.
 
@@ -155,15 +168,27 @@ A `BillOfLadingV1NotifyParty` implements the following attributes:
 * `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.
+### Carrier Field
+The shipping company responsible for transporting the goods.
 
-A `BillOfLadingV1Shipper` implements the following attributes:
+A `BillOfLadingV1Carrier` 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.
+* `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.
+
+### 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.
 
 # Attributes
 The following fields are extracted for Bill of Lading V1:
@@ -186,7 +211,7 @@ puts result.document.inference.prediction.carrier.value
 **carrier_items** (Array<[BillOfLadingV1CarrierItem](#items-field)>): The goods being shipped.
 
 ```rb
-for carrier_items_elem in result.document.inference.prediction.carrier_items do
+result.document.inference.prediction.carrier_items do |carrier_items_elem|
   puts carrier_items_elem.value
 end
 ```

data/docs/{business_card_v1.md → global_products/business_card_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: Business Card OCR Ruby
+title: Ruby Client Library - Business Card
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-business-card-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Business Card API](https://platform.mindee.com/mindee/business_card).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [Business Card API](https://platform.mindee.com/mindee/business_card).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `business_card`                                    |
+> | Recommended Version            | `v1.0`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 Polling Limitations
+>
+> | Setting                         | Parameter name          | Default Value |
+> | ------------------------------- | ----------------------- | ------------- |
+> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
+> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
+> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Business Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -20,7 +46,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::BusinessCard::BusinessCardV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -70,12 +95,12 @@ These fields are generic and used in several products.
 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.
+* **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** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **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.
@@ -153,7 +178,7 @@ puts result.document.inference.prediction.phone_number.value
 **social_media** (Array<[StringField](#string-field)>): The social media profiles of the person or company.
 
 ```rb
-for social_media_elem in result.document.inference.prediction.social_media do
+result.document.inference.prediction.social_media do |social_media_elem|
   puts social_media_elem.value
 end
 ```