mindee 3.15.0 → 3.16.0

data/docs/ind_passport_v1.md

@@ -0,0 +1,281 @@
+---
+title: IND Passport - India OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-ind-passport---india-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Passport - India API](https://platform.mindee.com/mindee/ind_passport).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Passport - India sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/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::IND::IndianPassport::IndianPassportV1
+)
+
+# 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: cf88fd43-eaa1-497a-ba29-a9569a4edaa7
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/ind_passport v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Page Number: 1
+:Country: IND
+:ID Number: J8369854
+:Given Names: JOCELYN MICHELLE
+:Surname: DOE
+:Birth Date: 1959-09-23
+:Birth Place: GUNDUGOLANU
+:Issuance Place: HYDERABAD
+:Gender: F
+:Issuance Date: 2011-10-11
+:Expiry Date: 2021-10-10
+:MRZ Line 1: P<DOE<<JOCELYNMICHELLE<<<<<<<<<<<<<<<<<<<<<
+:MRZ Line 2: J8369854<4IND5909234F2110101<<<<<<<<<<<<<<<8
+:Legal Guardian:
+:Name of Spouse:
+:Name of Mother:
+:Old Passport Date of Issue:
+:Old Passport Number:
+:Address Line 1:
+:Address Line 2:
+:Address Line 3:
+:Old Passport Place of Issue:
+:File Number:
+```
+
+# 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.
+
+
+### Classification Field
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+
+> Note: a classification field's `value is always 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`).
+
+# Attributes
+The following fields are extracted for Passport - India V1:
+
+## Address Line 1
+**address1** ([StringField](#string-field)): The first line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address1.value
+```
+
+## Address Line 2
+**address2** ([StringField](#string-field)): The second line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address2.value
+```
+
+## Address Line 3
+**address3** ([StringField](#string-field)): The third line of the address of the passport holder.
+
+```rb
+puts result.document.inference.prediction.address3.value
+```
+
+## Birth Date
+**birth_date** ([DateField](#date-field)): The birth date of the passport holder, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.birth_date.value
+```
+
+## Birth Place
+**birth_place** ([StringField](#string-field)): The birth place of the passport holder.
+
+```rb
+puts result.document.inference.prediction.birth_place.value
+```
+
+## Country
+**country** ([StringField](#string-field)): ISO 3166-1 alpha-3 country code (3 letters format).
+
+```rb
+puts result.document.inference.prediction.country.value
+```
+
+## Expiry Date
+**expiry_date** ([DateField](#date-field)): The date when the passport will expire, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## File Number
+**file_number** ([StringField](#string-field)): The file number of the passport document.
+
+```rb
+puts result.document.inference.prediction.file_number.value
+```
+
+## Gender
+**gender** ([ClassificationField](#classification-field)): The gender of the passport holder.
+
+#### Possible values include:
+ - M
+ - F
+
+```rb
+puts result.document.inference.prediction.gender.value
+```
+
+## Given Names
+**given_names** ([StringField](#string-field)): The given names of the passport holder.
+
+```rb
+puts result.document.inference.prediction.given_names.value
+```
+
+## ID Number
+**id_number** ([StringField](#string-field)): The identification number of the passport document.
+
+```rb
+puts result.document.inference.prediction.id_number.value
+```
+
+## Issuance Date
+**issuance_date** ([DateField](#date-field)): The date when the passport was issued, ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.issuance_date.value
+```
+
+## Issuance Place
+**issuance_place** ([StringField](#string-field)): The place where the passport was issued.
+
+```rb
+puts result.document.inference.prediction.issuance_place.value
+```
+
+## Legal Guardian
+**legal_guardian** ([StringField](#string-field)): The name of the legal guardian of the passport holder (if applicable).
+
+```rb
+puts result.document.inference.prediction.legal_guardian.value
+```
+
+## MRZ Line 1
+**mrz1** ([StringField](#string-field)): The first line of the machine-readable zone (MRZ) of the passport document.
+
+```rb
+puts result.document.inference.prediction.mrz1.value
+```
+
+## MRZ Line 2
+**mrz2** ([StringField](#string-field)): The second line of the machine-readable zone (MRZ) of the passport document.
+
+```rb
+puts result.document.inference.prediction.mrz2.value
+```
+
+## Name of Mother
+**name_of_mother** ([StringField](#string-field)): The name of the mother of the passport holder.
+
+```rb
+puts result.document.inference.prediction.name_of_mother.value
+```
+
+## Name of Spouse
+**name_of_spouse** ([StringField](#string-field)): The name of the spouse of the passport holder (if applicable).
+
+```rb
+puts result.document.inference.prediction.name_of_spouse.value
+```
+
+## Old Passport Date of Issue
+**old_passport_date_of_issue** ([DateField](#date-field)): The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
+
+```rb
+puts result.document.inference.prediction.old_passport_date_of_issue.value
+```
+
+## Old Passport Number
+**old_passport_number** ([StringField](#string-field)): The number of the old passport (if applicable).
+
+```rb
+puts result.document.inference.prediction.old_passport_number.value
+```
+
+## Old Passport Place of Issue
+**old_passport_place_of_issue** ([StringField](#string-field)): The place of issue of the old passport (if applicable).
+
+```rb
+puts result.document.inference.prediction.old_passport_place_of_issue.value
+```
+
+## Page Number
+**page_number** ([ClassificationField](#classification-field)): The page number of the passport document.
+
+#### Possible values include:
+ - 1
+ - 2
+
+```rb
+puts result.document.inference.prediction.page_number.value
+```
+
+## Surname
+**surname** ([StringField](#string-field)): The surname of the passport holder.
+
+```rb
+puts result.document.inference.prediction.surname.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/invoices_v4.md

@@ -63,21 +63,23 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 372d9d08-59d8-4e1c-9622-06648c1c238b
+:Mindee ID: a67b70ea-4b1e-4eac-ae75-dda47a7064ae
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.7
+:Product: mindee/invoices v4.9
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; CAD;
+:Locale: en-CA; en; CA; CAD;
 :Invoice Number: 14
+:Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date:
+:Due Date: 2011-12-01
+:Payment Date: 2011-12-01
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -93,7 +95,7 @@ Prediction
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: ldoi@example.com
+:Supplier Email: j_coi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
@@ -117,11 +119,13 @@ Page Predictions
 
 Page 0
 ------
-:Locale: en; en; CAD;
+:Locale: en-CA; en; CA; CAD;
 :Invoice Number: 14
+:Purchase Order Number: AD29094
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date:
+:Due Date: 2011-12-01
+:Payment Date: 2011-12-01
 :Total Net: 2145.00
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -137,7 +141,7 @@ Page 0
 :Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
 :Supplier Phone Number: 4165551212
 :Supplier Website:
-:Supplier Email: ldoi@example.com
+:Supplier Email: j_coi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada

data/docs/resume_v1.md

@@ -38,13 +38,13 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: bc80bae0-af75-4464-95a9-2419403c75bf
+:Mindee ID: 9daa3085-152c-454e-9245-636f13fc9dc3
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/resume v1.0
-:Rotation applied: No
+:Product: mindee/resume v1.1
+:Rotation applied: Yes
 
 Prediction
 ==========
@@ -54,8 +54,8 @@ Prediction
 :Surnames: Morgan
 :Nationality:
 :Email Address: christoper.m@gmail.com
-:Phone Number: +44 (0) 20 7666 8555
-:Address: 177 Great Portland Street, London W5W 6PQ
+:Phone Number: +44 (0)20 7666 8555
+:Address: 177 Great Portland Street, London, W5W 6PQ
 :Social Networks:
   +----------------------+----------------------------------------------------+
   | Name                 | URL                                                |
@@ -72,38 +72,37 @@ Prediction
   +----------+----------------------+
   | ZHO      | Beginner             |
   +----------+----------------------+
-  | DEU      | Intermediate         |
+  | DEU      | Beginner             |
   +----------+----------------------+
 :Hard Skills: HTML5
               PHP OOP
               JavaScript
               CSS
               MySQL
+              SQL
 :Soft Skills: Project management
+              Creative design
               Strong decision maker
               Innovative
               Complex problem solver
-              Creative design
               Service-focused
 :Education:
   +-----------------+---------------------------+-----------+----------+---------------------------+-------------+------------+
   | Domain          | Degree                    | End Month | End Year | School                    | Start Month | Start Year |
   +=================+===========================+===========+==========+===========================+=============+============+
-  | Computer Inf... | Bachelor                  |           |          | Columbia University, NY   |             | 2014       |
+  | Computer Inf... | Bachelor                  |           | 2014     | Columbia University, NY   |             |            |
   +-----------------+---------------------------+-----------+----------+---------------------------+-------------+------------+
 :Professional Experiences:
-  +-----------------+------------+---------------------------+-----------+----------+----------------------+-------------+------------+
-  | Contract Type   | Department | Employer                  | End Month | End Year | Role                 | Start Month | Start Year |
-  +=================+============+===========================+===========+==========+======================+=============+============+
-  | Full-Time       |            | Luna Web Design, New York | 05        | 2019     | Web Developer        | 09          | 2015       |
-  +-----------------+------------+---------------------------+-----------+----------+----------------------+-------------+------------+
+  +-----------------+------------+--------------------------------------+---------------------------+-----------+----------+----------------------+-------------+------------+
+  | Contract Type   | Department | Description                          | Employer                  | End Month | End Year | Role                 | Start Month | Start Year |
+  +=================+============+======================================+===========================+===========+==========+======================+=============+============+
+  |                 |            | Cooperate with designers to creat... | Luna Web Design, New York | 05        | 2019     | Web Developer        | 09          | 2015       |
+  +-----------------+------------+--------------------------------------+---------------------------+-----------+----------+----------------------+-------------+------------+
 :Certificates:
   +------------+--------------------------------+---------------------------+------+
   | Grade      | Name                           | Provider                  | Year |
   +============+================================+===========================+======+
-  |            | PHP Framework (certificate)... |                           | 2014 |
-  +------------+--------------------------------+---------------------------+------+
-  |            | Programming Languages: Java... |                           |      |
+  |            | PHP Framework (certificate)... |                           |      |
   +------------+--------------------------------+---------------------------+------+
 ```
 
@@ -171,6 +170,7 @@ A `ResumeV1Language` implements the following attributes:
 * `level` (String): The candidate's level for the language.
 
 #### Possible values include:
+ - Native
  - Fluent
  - Proficient
  - Intermediate
@@ -192,6 +192,7 @@ A `ResumeV1ProfessionalExperience` implements the following attributes:
  - Freelance
 
 * `department` (String): The specific department or division within the company.
+* `description` (String): The description of the professional experience as written in the document.
 * `employer` (String): The name of the company or organization.
 * `end_month` (String): The month when the professional experience ended.
 * `end_year` (String): The year when the professional experience ended.

data/lib/mindee/client.rb

@@ -149,8 +149,8 @@ module Mindee
     #  * `:on_min_pages` Apply the operation only if document has at least this many pages.
     # @param cropper [Boolean, nil] Whether to include cropper results for each page.
     #  This performs a cropping operation on the server and will increase response time.
-    # @param initial_delay_sec [Integer, Float] initial delay before polling. Defaults to 4.
-    # @param delay_sec [Integer, Float] delay between polling attempts. Defaults to 2.
+    # @param initial_delay_sec [Integer, Float] initial delay before polling. Defaults to 2.
+    # @param delay_sec [Integer, Float] delay between polling attempts. Defaults to 1.5.
     # @param max_retries [Integer] maximum amount of retries. Defaults to 60.
     # @return [Mindee::Parsing::Common::ApiResponse]
     def enqueue_and_parse(
@@ -162,8 +162,8 @@ module Mindee
       close_file: true,
       page_options: nil,
       cropper: false,
-      initial_delay_sec: 4,
-      delay_sec: 2,
+      initial_delay_sec: 2,
+      delay_sec: 1.5,
       max_retries: 60
     )
       enqueue_res = enqueue(
@@ -272,13 +272,13 @@ module Mindee
     # @param max_retries [Integer, nil] maximum amount of retries.
     def validate_async_params(initial_delay_sec, delay_sec, max_retries)
       min_delay_sec = 1
-      min_initial_delay_sec = 2
+      min_initial_delay_sec = 1
       min_retries = 2
-      raise "Cannot set auto-poll delay to less than #{min_delay_sec} seconds" if delay_sec < min_delay_sec
+      raise "Cannot set auto-poll delay to less than #{min_delay_sec} second(s)" if delay_sec < min_delay_sec
       if initial_delay_sec < min_initial_delay_sec
-        raise "Cannot set initial parsing delay to less than #{min_initial_delay_sec} seconds"
+        raise "Cannot set initial parsing delay to less than #{min_initial_delay_sec} second(s)"
       end
-      raise "Cannot set auto-poll delay to less than #{min_retries} seconds" if max_retries < min_retries
+      raise "Cannot set auto-poll retries to less than #{min_retries}" if max_retries < min_retries
     end
 
     # Creates an endpoint with the given values. Raises an error if the endpoint is invalid.

data/lib/mindee/product/business_card/business_card_v1.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'business_card_v1_document'
+require_relative 'business_card_v1_page'
+
+module Mindee
+  module Product
+    # Business Card module.
+    module BusinessCard
+      # Business Card API version 1 inference prediction.
+      class BusinessCardV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'business_card'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = BusinessCardV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(BusinessCardV1Page.new(page))
+            end
+          end
+        end
+
+        class << self
+          # Name of the endpoint for this product.
+          # @return [String]
+          attr_reader :endpoint_name
+          # Version for this product.
+          # @return [String]
+          attr_reader :endpoint_version
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/business_card/business_card_v1_document.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BusinessCard
+      # Business Card API version 1.0 document data.
+      class BusinessCardV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The address of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :address
+        # The company the person works for.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :company
+        # The email address of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :email
+        # The Fax number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :fax_number
+        # The given name of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :firstname
+        # The job title of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :job_title
+        # The lastname of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :lastname
+        # The mobile number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mobile_number
+        # The phone number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :phone_number
+        # The social media profiles of the person or company.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :social_media
+        # The website of the person or company.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :website
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @address = StringField.new(prediction['address'], page_id)
+          @company = StringField.new(prediction['company'], page_id)
+          @email = StringField.new(prediction['email'], page_id)
+          @fax_number = StringField.new(prediction['fax_number'], page_id)
+          @firstname = StringField.new(prediction['firstname'], page_id)
+          @job_title = StringField.new(prediction['job_title'], page_id)
+          @lastname = StringField.new(prediction['lastname'], page_id)
+          @mobile_number = StringField.new(prediction['mobile_number'], page_id)
+          @phone_number = StringField.new(prediction['phone_number'], page_id)
+          @social_media = []
+          prediction['social_media'].each do |item|
+            @social_media.push(StringField.new(item, page_id))
+          end
+          @website = StringField.new(prediction['website'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          social_media = @social_media.join("\n #{' ' * 14}")
+          out_str = String.new
+          out_str << "\n:Firstname: #{@firstname}".rstrip
+          out_str << "\n:Lastname: #{@lastname}".rstrip
+          out_str << "\n:Job Title: #{@job_title}".rstrip
+          out_str << "\n:Company: #{@company}".rstrip
+          out_str << "\n:Email: #{@email}".rstrip
+          out_str << "\n:Phone Number: #{@phone_number}".rstrip
+          out_str << "\n:Mobile Number: #{@mobile_number}".rstrip
+          out_str << "\n:Fax Number: #{@fax_number}".rstrip
+          out_str << "\n:Address: #{@address}".rstrip
+          out_str << "\n:Website: #{@website}".rstrip
+          out_str << "\n:Social Media: #{social_media}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/business_card/business_card_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'business_card_v1_document'
+
+module Mindee
+  module Product
+    module BusinessCard
+      # Business Card API version 1.0 page data.
+      class BusinessCardV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = BusinessCardV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Business Card V1 page prediction.
+      class BusinessCardV1PagePrediction < BusinessCardV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/delivery_note/delivery_note_v1.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'delivery_note_v1_document'
+require_relative 'delivery_note_v1_page'
+
+module Mindee
+  module Product
+    # Delivery note module.
+    module DeliveryNote
+      # Delivery note API version 1 inference prediction.
+      class DeliveryNoteV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'delivery_notes'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = DeliveryNoteV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(DeliveryNoteV1Page.new(page))
+            end
+          end
+        end
+
+        class << self
+          # Name of the endpoint for this product.
+          # @return [String]
+          attr_reader :endpoint_name
+          # Version for this product.
+          # @return [String]
+          attr_reader :endpoint_version
+        end
+      end
+    end
+  end
+end