mindee 3.19.1 → 4.0.0

data/docs/payslip_fra_v2.md

@@ -1,294 +0,0 @@
----
-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/lib/mindee/extraction/common.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'common/extracted_image'
-require_relative 'common/image_extractor'

data/lib/mindee/extraction/multi_receipts_extractor/multi_receipts_extractor.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common/image_extractor'
-
-module Mindee
-  # Image Extraction Module.
-  module Extraction
-    # Multi-receipts extraction class wrapper.
-    class MultiReceiptsExtractor
-      def self.extract_receipts(input_source, inference)
-        # Extracts individual receipts from multi-receipts documents.
-        #
-        # @param input_source [LocalInputSource] Local Input Source to extract sub-receipts from.
-        # @param inference [Inference] Results of the inference.
-        # @return [Array<ExtractedImage>] Individual extracted receipts as an array of ExtractedMultiReceiptsImage.
-
-        images = []
-        raise 'No possible receipts candidates found for MultiReceipts extraction.' unless inference.prediction.receipts
-
-        (0...input_source.count_pdf_pages).each do |page_id|
-          receipt_positions = inference.pages[page_id].prediction.receipts.map(&:bounding_box)
-          images.concat(
-            Mindee::Extraction::ImageExtractor.extract_multiple_images_from_source(input_source, page_id + 1,
-                                                                                   receipt_positions)
-          )
-        end
-
-        images
-      end
-    end
-  end
-end

data/lib/mindee/extraction/pdf_extractor.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'pdf_extractor/pdf_extractor'
-require_relative 'pdf_extractor/extracted_pdf'

data/lib/mindee/extraction/tax_extractor/ocr_extractor.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Extraction
-    # Generic extractor class
-    class OcrExtractor
-      # Checks for a list of possible matches in a string & returns the index of the first found candidate.
-      # Case & diacritics insensitive.
-      # @param text [String] string to search for matches.
-      # @param str_candidates [Array<String>] array of values to look for
-      # @return [Integer, nil]
-      def self.match_index(text, str_candidates)
-        idx = nil
-        str_candidates.each do |str_candidate|
-          found_idx = remove_accents(text.downcase).index(remove_accents(str_candidate.downcase))
-          idx = found_idx if idx.nil?
-          idx = found_idx if !found_idx.nil? && found_idx >= idx
-        end
-        idx
-      end
-
-      # Normalizes text by removing diacritics.
-      # @param input_str [String] string to handle.
-      # @return [String]
-      def self.remove_accents(input_str)
-        diacritics = [*0x1DC0..0x1DFF, *0x0300..0x036F, *0xFE20..0xFE2F].pack('U*')
-        input_str
-          .unicode_normalize(:nfd)
-          .tr(diacritics, '')
-          .unicode_normalize(:nfc)
-          .scrub
-      end
-
-      # Checks if a given percentage value is within the allowed range
-      # @param value [Integer] The value to check
-      # @param min_rate_percentage [Integer] Minimum allowed rate on the tax.
-      # @param max_rate_percentage [Integer] Maximum allowed rate on the tax.
-      # @return [Boolean]
-      def self.valid_percentage?(value, min_rate_percentage, max_rate_percentage)
-        return false if value.nil?
-
-        value > min_rate_percentage && value < max_rate_percentage
-      end
-
-      # Parses a percentage from a string, and returns it as a float.
-      # Returns nil if candidate isn't a valid percentage.
-      # @param percentage_str [String] String candidate.
-      # @return [Float, nil]
-      def self.parse_percentage(percentage_str)
-        percentage_str.gsub!('%', '')
-        percentage_str.strip
-        percentage_str.gsub!(',', '.')
-        Float(percentage_str.scrub)
-      rescue ArgumentError
-        nil
-      end
-
-      # Parses an amount from a string, and returns it as a float.
-      # Returns nil if candidate isn't a valid amount.
-      # @param amount_str [String] String candidate.
-      # @return [Float, nil]
-      def self.parse_amount(amount_str)
-        cleaned_str = amount_str.gsub(' ', '')
-        cleaned_str = standardize_delimiters(cleaned_str)
-        Float(cleaned_str)
-      rescue ArgumentError
-        nil
-      end
-
-      private
-
-      def self.standardize_delimiters(str)
-        if comma_decimal?(str)
-          str.gsub('.', '').gsub(',', '.')
-        elsif dot_decimal?(str)
-          str.gsub(',', '')
-        else
-          str
-        end
-      end
-
-      def self.comma_decimal?(str)
-        (str.length > 3 && str[-3] == ',') || str[-2] == ','
-      end
-
-      def self.dot_decimal?(str)
-        (str.length > 3 && str[-3] == '.') || str[-2] == '.'
-      end
-
-      # Removes most common currency symbols from string
-      # @param input_string [String] string to remove the symbols from
-      # @return [String]
-      def self.remove_currency_symbols(input_string)
-        # Define an array of common currency symbols
-        currency_symbols = ['$', '€', '£', '¥', '₹', '₽', '฿', '₺', '₴', '₿', '₡', '₮', '₱', '₲', '₪', '₫', '₩', '₵',
-                            '₦', '₢', '₤', '₣', '₧', '₯', '₠', '₶', '₸', '₷', '₼', '₾', '₺', '﹩', '₨', '₹', '＄', '﹫']
-
-        # Iterate over each currency symbol and remove it from the input string
-        currency_symbols.each do |symbol|
-          input_string.gsub!(symbol, '')
-        end
-
-        input_string
-      end
-
-      private_class_method :remove_accents, :match_index, :parse_amount, :parse_percentage, :remove_currency_symbols,
-                           :valid_percentage?, :comma_decimal?, :dot_decimal?, :standardize_delimiters
-    end
-  end
-end