mindee 3.12.0 → 3.14.0

data/docs/payslip_fra_v2.md

@@ -0,0 +1,294 @@
+---
+title: FR Payslip OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-payslip-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Payslip API](https://platform.mindee.com/mindee/payslip_fra).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Payslip sample](https://github.com/mindee/client-lib-test-data/blob/main/products/payslip_fra/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::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
+
+```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: 972edba5-25aa-49d0-8431-e2557ddd788e
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/payslip_fra v2.0
+:Rotation applied: No
+
+Prediction
+==========
+:Employee:
+  :Address: 52 RUE DES FLEURS 33500 LIBOURNE FRANCE
+  :Date of Birth:
+  :First Name: Jean Luc
+  :Last Name: Picard
+  :Phone Number:
+  :Registration Number:
+  :Social Security Number: 123456789012345
+:Employer:
+  :Address: 1 RUE DU TONNOT 25210 DOUBS
+  :Company ID: 12345678901234
+  :Company Site:
+  :NAF Code: 1234A
+  :Name: DEMO COMPANY
+  :Phone Number:
+  :URSSAF Number:
+:Bank Account Details:
+  :Bank Name:
+  :IBAN:
+  :SWIFT:
+:Employment:
+  :Category: Cadre
+  :Coefficient: 600.00
+  :Collective Agreement: Construction -- Promotion
+  :Job Title: Directeur Régional du Développement
+  :Position Level:
+  :Start Date: 2022-05-01
+:Salary Details:
+  +--------------+-----------+--------------------------------------+-----------+
+  | Amount       | Base      | Description                          | Rate      |
+  +==============+===========+======================================+===========+
+  | 6666.67      |           | Salaire de base                      |           |
+  +--------------+-----------+--------------------------------------+-----------+
+  | 9.30         |           | Part patronale Mutuelle NR           |           |
+  +--------------+-----------+--------------------------------------+-----------+
+  | 508.30       |           | Avantages en nature voiture          |           |
+  +--------------+-----------+--------------------------------------+-----------+
+:Pay Detail:
+  :Gross Salary: 7184.27
+  :Gross Salary YTD: 18074.81
+  :Income Tax Rate: 17.60
+  :Income Tax Withheld: 1030.99
+  :Net Paid: 3868.32
+  :Net Paid Before Tax: 4899.31
+  :Net Taxable: 5857.90
+  :Net Taxable YTD: 14752.73
+  :Total Cost Employer: 10486.94
+  :Total Taxes and Deductions: 1650.36
+:PTO:
+  :Accrued This Period: 6.17
+  :Balance End of Period: 6.17
+  :Used This Period:
+:Pay Period:
+  :End Date: 2023-03-31
+  :Month: 03
+  :Payment Date: 2023-03-29
+  :Start Date: 2023-03-01
+  :Year: 2023
+```
+
+# 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.
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Bank Account Details Field
+Information about the employee's bank account.
+
+A `PayslipV2BankAccountDetail` implements the following attributes:
+
+* `bank_name` (String): The name of the bank.
+* `iban` (String): The IBAN of the bank account.
+* `swift` (String): The SWIFT code of the bank.
+Fields which are specific to this product; they are not used in any other product.
+
+### Employee Field
+Information about the employee.
+
+A `PayslipV2Employee` implements the following attributes:
+
+* `address` (String): The address of the employee.
+* `date_of_birth` (String): The date of birth of the employee.
+* `first_name` (String): The first name of the employee.
+* `last_name` (String): The last name of the employee.
+* `phone_number` (String): The phone number of the employee.
+* `registration_number` (String): The registration number of the employee.
+* `social_security_number` (String): The social security number of the employee.
+Fields which are specific to this product; they are not used in any other product.
+
+### Employer Field
+Information about the employer.
+
+A `PayslipV2Employer` implements the following attributes:
+
+* `address` (String): The address of the employer.
+* `company_id` (String): The company ID of the employer.
+* `company_site` (String): The site of the company.
+* `naf_code` (String): The NAF code of the employer.
+* `name` (String): The name of the employer.
+* `phone_number` (String): The phone number of the employer.
+* `urssaf_number` (String): The URSSAF number of the employer.
+Fields which are specific to this product; they are not used in any other product.
+
+### Employment Field
+Information about the employment.
+
+A `PayslipV2Employment` implements the following attributes:
+
+* `category` (String): The category of the employment.
+* `coefficient` (Float): The coefficient of the employment.
+* `collective_agreement` (String): The collective agreement of the employment.
+* `job_title` (String): The job title of the employee.
+* `position_level` (String): The position level of the employment.
+* `start_date` (String): The start date of the employment.
+Fields which are specific to this product; they are not used in any other product.
+
+### Pay Detail Field
+Detailed information about the pay.
+
+A `PayslipV2PayDetail` implements the following attributes:
+
+* `gross_salary` (Float): The gross salary of the employee.
+* `gross_salary_ytd` (Float): The year-to-date gross salary of the employee.
+* `income_tax_rate` (Float): The income tax rate of the employee.
+* `income_tax_withheld` (Float): The income tax withheld from the employee's pay.
+* `net_paid` (Float): The net paid amount of the employee.
+* `net_paid_before_tax` (Float): The net paid amount before tax of the employee.
+* `net_taxable` (Float): The net taxable amount of the employee.
+* `net_taxable_ytd` (Float): The year-to-date net taxable amount of the employee.
+* `total_cost_employer` (Float): The total cost to the employer.
+* `total_taxes_and_deductions` (Float): The total taxes and deductions of the employee.
+Fields which are specific to this product; they are not used in any other product.
+
+### Pay Period Field
+Information about the pay period.
+
+A `PayslipV2PayPeriod` implements the following attributes:
+
+* `end_date` (String): The end date of the pay period.
+* `month` (String): The month of the pay period.
+* `payment_date` (String): The date of payment for the pay period.
+* `start_date` (String): The start date of the pay period.
+* `year` (String): The year of the pay period.
+Fields which are specific to this product; they are not used in any other product.
+
+### PTO Field
+Information about paid time off.
+
+A `PayslipV2Pto` implements the following attributes:
+
+* `accrued_this_period` (Float): The amount of paid time off accrued in this period.
+* `balance_end_of_period` (Float): The balance of paid time off at the end of the period.
+* `used_this_period` (Float): The amount of paid time off used in this period.
+Fields which are specific to this product; they are not used in any other product.
+
+### Salary Details Field
+Detailed information about the earnings.
+
+A `PayslipV2SalaryDetail` implements the following attributes:
+
+* `amount` (Float): The amount of the earnings.
+* `base` (Float): The base value of the earnings.
+* `description` (String): The description of the earnings.
+* `rate` (Float): The rate of the earnings.
+
+# Attributes
+The following fields are extracted for Payslip V2:
+
+## Bank Account Details
+**bank_account_details** ([PayslipV2BankAccountDetail](#bank-account-details-field)): Information about the employee's bank account.
+
+```rb
+puts result.document.inference.prediction.bank_account_details.value
+```
+
+## Employee
+**employee** ([PayslipV2Employee](#employee-field)): Information about the employee.
+
+```rb
+puts result.document.inference.prediction.employee.value
+```
+
+## Employer
+**employer** ([PayslipV2Employer](#employer-field)): Information about the employer.
+
+```rb
+puts result.document.inference.prediction.employer.value
+```
+
+## Employment
+**employment** ([PayslipV2Employment](#employment-field)): Information about the employment.
+
+```rb
+puts result.document.inference.prediction.employment.value
+```
+
+## Pay Detail
+**pay_detail** ([PayslipV2PayDetail](#pay-detail-field)): Detailed information about the pay.
+
+```rb
+puts result.document.inference.prediction.pay_detail.value
+```
+
+## Pay Period
+**pay_period** ([PayslipV2PayPeriod](#pay-period-field)): Information about the pay period.
+
+```rb
+puts result.document.inference.prediction.pay_period.value
+```
+
+## PTO
+**pto** ([PayslipV2Pto](#pto-field)): Information about paid time off.
+
+```rb
+puts result.document.inference.prediction.pto.value
+```
+
+## Salary Details
+**salary_details** (Array<[PayslipV2SalaryDetail](#salary-details-field)>): Detailed information about the earnings.
+
+```rb
+for salary_details_elem in result.document.inference.prediction.salary_details do
+  puts salary_details_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/proof_of_address_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Proof of Address OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-proof-of-address-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Proof of Address API](https://platform.mindee.com/mindee/proof_of_address).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -104,7 +108,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/resume_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Resume OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-resume-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Resume API](https://platform.mindee.com/mindee/resume).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -115,7 +119,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).
 
 
@@ -165,6 +169,13 @@ A `ResumeV1Language` implements the following attributes:
 
 * `language` (String): The language's ISO 639 code.
 * `level` (String): The candidate's level for the language.
+
+#### Possible values include:
+ - Fluent
+ - Proficient
+ - Intermediate
+ - Beginner
+
 Fields which are specific to this product; they are not used in any other product.
 
 ### Professional Experiences Field
@@ -173,6 +184,13 @@ The list of the candidate's professional experiences.
 A `ResumeV1ProfessionalExperience` implements the following attributes:
 
 * `contract_type` (String): The type of contract for the professional experience.
+
+#### Possible values include:
+ - Full-Time
+ - Part-Time
+ - Internship
+ - Freelance
+
 * `department` (String): The specific department or division within the company.
 * `employer` (String): The name of the company or organization.
 * `end_month` (String): The month when the professional experience ended.
@@ -219,6 +237,11 @@ puts result.document.inference.prediction.document_language.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): The type of the document sent.
 
+#### Possible values include:
+ - RESUME
+ - MOTIVATION_LETTER
+ - RECOMMENDATION_LETTER
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```

data/docs/us_driver_license_v1.md

@@ -1,5 +1,8 @@
 ---
 title: US Driver License OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-us-driver-license-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/us_driver_license).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -100,7 +104,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).
 
 
@@ -122,7 +126,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 Driver License V1:

data/docs/us_healthcare_cards_v1.md

@@ -1,5 +1,8 @@
 ---
 title: US Healthcare Card OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-us-healthcare-card-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Healthcare Card API](https://platform.mindee.com/mindee/us_healthcare_cards).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -84,7 +88,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/us_mail_v2.md

@@ -1,5 +1,8 @@
 ---
 title: US US Mail OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-us-us-mail-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -34,7 +38,7 @@ puts result.document
 :Sender Name: zed
 :Sender Address:
   :City: Dallas
-  :Complete Address: 54321 Elm Street, Dallas, Texas ...
+  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
   :Postal Code: 54321
   :State: TX
   :Street: 54321 Elm Street
@@ -59,7 +63,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/us_w9_v1.md

@@ -1,5 +1,8 @@
 ---
 title: US W9 OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-us-w9-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [W9 API](https://platform.mindee.com/mindee/us_w9).
 
@@ -24,6 +27,7 @@ result = mindee_client.parse(
 
 # Print a full summary of the parsed data in RST format
 puts result.document
+
 ```
 
 **Output (RST):**
@@ -73,7 +77,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).
 
 
@@ -90,7 +94,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 W9 V1:

data/examples/auto_invoice_splitter_extraction.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'mindee'
+
+def invoice_splitter_auto_extraction(file_path)
+  mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+  input_source = mindee_client.source_from_path(file_path)
+
+  if input_source.pdf? && input_source.count_pdf_pages > 1
+    parse_multi_page(mindee_client, input_source)
+  else
+    parse_single_page(mindee_client, input_source)
+  end
+end
+
+def parse_single_page(mindee_client, input_source)
+  invoice_result = mindee_client.parse(
+    input_source,
+    Mindee::Product::Invoice::InvoiceV4
+  )
+  puts invoice_result.document
+end
+
+def parse_multi_page(mindee_client, input_source)
+  pdf_extractor = Mindee::Extraction::PdfExtractor::PdfExtractor.new(input_source)
+  invoice_splitter_response = mindee_client.enqueue_and_parse(
+    input_source,
+    Mindee::Product::InvoiceSplitter::InvoiceSplitterV1,
+    close_file: false
+  )
+  page_groups = invoice_splitter_response.document.inference.prediction.invoice_page_groups
+  extracted_pdfs = pdf_extractor.extract_invoices(page_groups, strict: false)
+
+  extracted_pdfs.each do |extracted_pdf|
+    # Optional: Save the files locally
+    # extracted_pdf.write_to_file("output/path")
+
+    invoice_result = mindee_client.parse(
+      extracted_pdf.as_input_source,
+      Mindee::Product::Invoice::InvoiceV4,
+      close_file: false
+    )
+    puts invoice_result.document
+  end
+end
+
+my_file_path = '/path/to/the/file.ext'
+invoice_splitter_auto_extraction(my_file_path)

data/examples/auto_multi_receipts_detector_extraction.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'mindee'
+require 'mindee/extraction'
+
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+def multi_receipts_detection(file_path, mindee_client)
+  input_source = mindee_client.source_from_path(file_path)
+
+  result_split = mindee_client.parse(
+    input_source,
+    Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1,
+    close_file: false
+  )
+
+  images = Mindee::Extraction::MultiReceiptsExtractor.extract_receipts(input_source, result_split.document.inference)
+  images.each do |sub_image|
+    # Optional: Save the files locally
+    # sub_image.write_to_file("/path/to/my/extracted/file/folder")
+
+    result_receipt = mindee_client.parse(
+      sub_image.as_source,
+      Mindee::Product::Receipt::ReceiptV5,
+      close_file: false
+    )
+    puts result_receipt.document
+  end
+end
+
+my_file_path = '/path/to/the/file.ext'
+multi_receipts_detection(my_file_path, mindee_client)