mindee 3.4.0 → 3.6.0

data/lib/mindee/product/resume/resume_v1_education.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of the candidate's educational background.
+      class ResumeV1Education < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The area of study or specialization.
+        # @return [String]
+        attr_reader :degree_domain
+        # The type of degree obtained, such as Bachelor's, Master's, or Doctorate.
+        # @return [String]
+        attr_reader :degree_type
+        # The month when the education program or course was completed.
+        # @return [String]
+        attr_reader :end_month
+        # The year when the education program or course was completed.
+        # @return [String]
+        attr_reader :end_year
+        # The name of the school.
+        # @return [String]
+        attr_reader :school
+        # The month when the education program or course began.
+        # @return [String]
+        attr_reader :start_month
+        # The year when the education program or course began.
+        # @return [String]
+        attr_reader :start_year
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @degree_domain = prediction['degree_domain']
+          @degree_type = prediction['degree_type']
+          @end_month = prediction['end_month']
+          @end_year = prediction['end_year']
+          @school = prediction['school']
+          @start_month = prediction['start_month']
+          @start_year = prediction['start_year']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:degree_domain] = format_for_display(@degree_domain, 15)
+          printable[:degree_type] = format_for_display(@degree_type, 25)
+          printable[:end_month] = format_for_display(@end_month, nil)
+          printable[:end_year] = format_for_display(@end_year, nil)
+          printable[:school] = format_for_display(@school, 25)
+          printable[:start_month] = format_for_display(@start_month, nil)
+          printable[:start_year] = format_for_display(@start_year, nil)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 16s', printable[:degree_domain])
+          out_str << format('| %- 26s', printable[:degree_type])
+          out_str << format('| %- 10s', printable[:end_month])
+          out_str << format('| %- 9s', printable[:end_year])
+          out_str << format('| %- 26s', printable[:school])
+          out_str << format('| %- 12s', printable[:start_month])
+          out_str << format('| %- 11s', printable[:start_year])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Domain: #{printable[:degree_domain]}"
+          out_str << "\n  :Degree: #{printable[:degree_type]}"
+          out_str << "\n  :End Month: #{printable[:end_month]}"
+          out_str << "\n  :End Year: #{printable[:end_year]}"
+          out_str << "\n  :School: #{printable[:school]}"
+          out_str << "\n  :Start Month: #{printable[:start_month]}"
+          out_str << "\n  :Start Year: #{printable[:start_year]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_language.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of languages that the candidate is proficient in.
+      class ResumeV1Language < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The language's ISO 639 code.
+        # @return [String]
+        attr_reader :language
+        # The candidate's level for the language.
+        # @return [String]
+        attr_reader :level
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @language = prediction['language']
+          @level = prediction['level']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:language] = format_for_display(@language, nil)
+          printable[:level] = format_for_display(@level, 20)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 9s', printable[:language])
+          out_str << format('| %- 21s', printable[:level])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Language: #{printable[:language]}"
+          out_str << "\n  :Level: #{printable[:level]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'resume_v1_document'
+
+module Mindee
+  module Product
+    module Resume
+      # Resume V1 page.
+      class ResumeV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = ResumeV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Resume V1 page prediction.
+      class ResumeV1PagePrediction < ResumeV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_professional_experience.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of the candidate's professional experiences.
+      class ResumeV1ProfessionalExperience < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The type of contract for the professional experience.
+        # @return [String]
+        attr_reader :contract_type
+        # The specific department or division within the company.
+        # @return [String]
+        attr_reader :department
+        # The name of the company or organization.
+        # @return [String]
+        attr_reader :employer
+        # The month when the professional experience ended.
+        # @return [String]
+        attr_reader :end_month
+        # The year when the professional experience ended.
+        # @return [String]
+        attr_reader :end_year
+        # The position or job title held by the candidate.
+        # @return [String]
+        attr_reader :role
+        # The month when the professional experience began.
+        # @return [String]
+        attr_reader :start_month
+        # The year when the professional experience began.
+        # @return [String]
+        attr_reader :start_year
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @contract_type = prediction['contract_type']
+          @department = prediction['department']
+          @employer = prediction['employer']
+          @end_month = prediction['end_month']
+          @end_year = prediction['end_year']
+          @role = prediction['role']
+          @start_month = prediction['start_month']
+          @start_year = prediction['start_year']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:contract_type] = format_for_display(@contract_type, 15)
+          printable[:department] = format_for_display(@department, 10)
+          printable[:employer] = format_for_display(@employer, 25)
+          printable[:end_month] = format_for_display(@end_month, nil)
+          printable[:end_year] = format_for_display(@end_year, nil)
+          printable[:role] = format_for_display(@role, 20)
+          printable[:start_month] = format_for_display(@start_month, nil)
+          printable[:start_year] = format_for_display(@start_year, nil)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 16s', printable[:contract_type])
+          out_str << format('| %- 11s', printable[:department])
+          out_str << format('| %- 26s', printable[:employer])
+          out_str << format('| %- 10s', printable[:end_month])
+          out_str << format('| %- 9s', printable[:end_year])
+          out_str << format('| %- 21s', printable[:role])
+          out_str << format('| %- 12s', printable[:start_month])
+          out_str << format('| %- 11s', printable[:start_year])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Contract Type: #{printable[:contract_type]}"
+          out_str << "\n  :Department: #{printable[:department]}"
+          out_str << "\n  :Employer: #{printable[:employer]}"
+          out_str << "\n  :End Month: #{printable[:end_month]}"
+          out_str << "\n  :End Year: #{printable[:end_year]}"
+          out_str << "\n  :Role: #{printable[:role]}"
+          out_str << "\n  :Start Month: #{printable[:start_month]}"
+          out_str << "\n  :Start Year: #{printable[:start_year]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_social_networks_url.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module Resume
+      # The list of social network profiles of the candidate.
+      class ResumeV1SocialNetworksUrl < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The name of the social network.
+        # @return [String]
+        attr_reader :name
+        # The URL of the social network.
+        # @return [String]
+        attr_reader :url
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @name = prediction['name']
+          @url = prediction['url']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:name] = format_for_display(@name, 20)
+          printable[:url] = format_for_display(@url, 50)
+          printable
+        end
+
+        # @return [String]
+        def to_table_line
+          printable = printable_values
+          out_str = String.new
+          out_str << format('| %- 21s', printable[:name])
+          out_str << format('| %- 51s', printable[:url])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :URL: #{printable[:url]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/us/bank_check/bank_check_v1.rb

@@ -20,7 +20,9 @@ module Mindee
             @prediction = BankCheckV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(BankCheckV1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(BankCheckV1Page.new(page))
+              end
             end
           end
 

data/lib/mindee/product/us/driver_license/driver_license_v1.rb

@@ -20,7 +20,9 @@ module Mindee
             @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(DriverLicenseV1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(DriverLicenseV1Page.new(page))
+              end
             end
           end
 

data/lib/mindee/product/us/w9/w9_v1.rb

@@ -20,7 +20,9 @@ module Mindee
             @prediction = W9V1Document.new
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(W9V1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(W9V1Page.new(page))
+              end
             end
           end
 

data/lib/mindee/product.rb

@@ -11,13 +11,19 @@ require_relative 'product/passport/passport_v1'
 require_relative 'product/receipt/receipt_v4'
 require_relative 'product/receipt/receipt_v5'
 require_relative 'product/eu/license_plate/license_plate_v1'
+require_relative 'product/eu/driver_license/driver_license_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
+require_relative 'product/fr/bank_statement/bank_statement_v1'
 require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
+require_relative 'product/generated/generated_v1'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
+require_relative 'product/international_id/international_id_v1'
+require_relative 'product/international_id/international_id_v2'
+require_relative 'product/resume/resume_v1'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

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

data/lib/mindee.rb

@@ -31,6 +31,10 @@ module Mindee
     # Standard fields and functions.
     module Standard
     end
+
+    # Generated fields and functions.
+    module Generated
+    end
   end
 
   # Document input-related internals.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -119,43 +119,54 @@ files:
 - bin/mindee.rb
 - docs/bank_account_details_v2.md
 - docs/bank_check_v1.md
+- docs/bank_statement_fr_v1.md
 - docs/barcode_reader_v1.md
 - docs/carte_grise_v1.md
 - docs/carte_vitale_v1.md
 - docs/code_samples/bank_account_details_v1.txt
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
+- docs/code_samples/bank_statement_fr_v1_async.txt
 - docs/code_samples/barcode_reader_v1.txt
 - docs/code_samples/carte_grise_v1.txt
 - docs/code_samples/carte_vitale_v1.txt
 - docs/code_samples/cropper_v1.txt
 - docs/code_samples/custom_v1.txt
 - docs/code_samples/default.txt
+- docs/code_samples/default_async.txt
+- docs/code_samples/eu_driver_license_v1.txt
 - docs/code_samples/expense_receipts_v4.txt
 - docs/code_samples/expense_receipts_v5.txt
 - docs/code_samples/financial_document_v1.txt
 - docs/code_samples/idcard_fr_v1.txt
 - docs/code_samples/idcard_fr_v2.txt
+- docs/code_samples/international_id_v1_async.txt
+- docs/code_samples/international_id_v2_async.txt
 - docs/code_samples/invoice_splitter_v1_async.txt
 - docs/code_samples/invoices_v4.txt
 - docs/code_samples/license_plates_v1.txt
 - docs/code_samples/multi_receipts_detector_v1.txt
 - docs/code_samples/passport_v1.txt
 - docs/code_samples/proof_of_address_v1.txt
+- docs/code_samples/resume_v1_async.txt
 - docs/code_samples/us_driver_license_v1.txt
 - docs/code_samples/us_w9_v1.txt
 - docs/cropper_v1.md
 - docs/custom_v1.md
+- docs/eu_driver_license_v1.md
 - docs/expense_receipts_v5.md
 - docs/financial_document_v1.md
+- docs/generated_v1.md
 - docs/getting_started.md
 - docs/idcard_fr_v2.md
+- docs/international_id_v2.md
 - docs/invoice_splitter_v1.md
 - docs/invoices_v4.md
 - docs/license_plates_v1.md
 - docs/multi_receipts_detector_v1.md
 - docs/passport_v1.md
 - docs/proof_of_address_v1.md
+- docs/resume_v1.md
 - docs/us_driver_license_v1.md
 - docs/us_w9_v1.md
 - lib/mindee.rb
@@ -187,6 +198,9 @@ files:
 - lib/mindee/parsing/custom.rb
 - lib/mindee/parsing/custom/classification_field.rb
 - lib/mindee/parsing/custom/list_field.rb
+- lib/mindee/parsing/generated.rb
+- lib/mindee/parsing/generated/generated_list_field.rb
+- lib/mindee/parsing/generated/generated_object_field.rb
 - lib/mindee/parsing/standard.rb
 - lib/mindee/parsing/standard/amount_field.rb
 - lib/mindee/parsing/standard/base_field.rb
@@ -212,6 +226,9 @@ files:
 - lib/mindee/product/custom/custom_v1.rb
 - lib/mindee/product/custom/custom_v1_document.rb
 - lib/mindee/product/custom/custom_v1_page.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1_document.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1_page.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1_document.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1_page.rb
@@ -226,6 +243,10 @@ files:
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_document.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_page.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_transaction.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb
@@ -238,6 +259,16 @@ files:
 - lib/mindee/product/fr/id_card/id_card_v2.rb
 - lib/mindee/product/fr/id_card/id_card_v2_document.rb
 - lib/mindee/product/fr/id_card/id_card_v2_page.rb
+- lib/mindee/product/generated/generated_v1.rb
+- lib/mindee/product/generated/generated_v1_document.rb
+- lib/mindee/product/generated/generated_v1_page.rb
+- lib/mindee/product/generated/generated_v1_prediction.rb
+- lib/mindee/product/international_id/international_id_v1.rb
+- lib/mindee/product/international_id/international_id_v1_document.rb
+- lib/mindee/product/international_id/international_id_v1_page.rb
+- lib/mindee/product/international_id/international_id_v2.rb
+- lib/mindee/product/international_id/international_id_v2_document.rb
+- lib/mindee/product/international_id/international_id_v2_page.rb
 - lib/mindee/product/invoice/invoice_v4.rb
 - lib/mindee/product/invoice/invoice_v4_document.rb
 - lib/mindee/product/invoice/invoice_v4_line_item.rb
@@ -261,6 +292,14 @@ files:
 - lib/mindee/product/receipt/receipt_v5_document.rb
 - lib/mindee/product/receipt/receipt_v5_line_item.rb
 - lib/mindee/product/receipt/receipt_v5_page.rb
+- lib/mindee/product/resume/resume_v1.rb
+- lib/mindee/product/resume/resume_v1_certificate.rb
+- lib/mindee/product/resume/resume_v1_document.rb
+- lib/mindee/product/resume/resume_v1_education.rb
+- lib/mindee/product/resume/resume_v1_language.rb
+- lib/mindee/product/resume/resume_v1_page.rb
+- lib/mindee/product/resume/resume_v1_professional_experience.rb
+- lib/mindee/product/resume/resume_v1_social_networks_url.rb
 - lib/mindee/product/us/bank_check/bank_check_v1.rb
 - lib/mindee/product/us/bank_check/bank_check_v1_document.rb
 - lib/mindee/product/us/bank_check/bank_check_v1_page.rb