mindee 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3711d1d33d9aeb118b9c891443d0e2ecf4973db242797f15d7628f3a157c0f8
-  data.tar.gz: b63e5dfd3a85fb3b234b0ae6d0afd8b1b2386eba3a2977788298e2cbf7ce79c9
+  metadata.gz: 28d1e6c48c575030a3c6519080f7cff23b52745c212d8db9cc43f8c800c1c3d8
+  data.tar.gz: a96015beeeac1378f72f77bd3bcb73c3032e0946e39cc7a4519b5db3eca3e8c4
 SHA512:
-  metadata.gz: 3ec2c83d25ca5e1cd72cc1045a5a6ed8f299dbdf3de2729344eac833a37351dd16a71d14b73679b441b7263e2992a577c618b3143484c8bfac262fd41697fbe5
-  data.tar.gz: 2de29dd3f708a25ef53e2c61aa86f40684d8ae2aac6cd875e931cd1e0cc0ed8e972439e75c8731e570b7fd7aa1a3884f5c341afe2a29fef40a37bc542ae60c15
+  metadata.gz: 2ca08ce6349eb1ebeaf7cf2bbba6004ff638cfc0db480d7b41bf183f6f6a4066bd1a76a36edbf4282eb65f31c89487cad388cc1f2ea6bfa2bb6bed7ff6c6e517
+  data.tar.gz: e18f1c1f8190c73987b036745fba0e6dca91b98ee71bc6144d8f1612be4c497cbb5f0301951b91db494c4812ca07ef6ec86fdeee17bdb3e83aacaef481b2fb3f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v3.6.0 - 2024-02-21
+### Changes
+* :sparkles: add support for resume V1
+
+
 ## v3.5.0 - 2024-02-16
 ### Changes
 * :sparkles: add support for Generated V1 API

data/README.md

@@ -142,6 +142,7 @@ customize the experience.
 * [Passport OCR Ruby](https://developers.mindee.com/docs/passport-ocr-ruby)
 * [Proof of Address OCR Ruby](https://developers.mindee.com/docs/proof-of-address-ocr-ruby)
 * [Receipt OCR Ruby](https://developers.mindee.com/docs/receipt-ocr-ruby)
+* [Resume OCR Ruby](https://developers.mindee.com/docs/resume-ocr-ruby)
 * [EU License Plate OCR Ruby](https://developers.mindee.com/docs/eu-license-plate-ocr-ruby)
 * [EU Driver License OCR Ruby](https://developers.mindee.com/docs/eu-driver-license-ocr-ruby)
 * [FR Bank Account Details OCR Ruby](https://developers.mindee.com/docs/fr-bank-account-details-ocr-ruby)
@@ -167,4 +168,4 @@ Copyright © Mindee, SA
 Available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/bin/mindee.rb

@@ -55,6 +55,12 @@ DOCUMENTS = {
     sync: true,
     async: false,
   },
+  "resume" => {
+    description: "Resume",
+    doc_class: Mindee::Product::Resume::ResumeV1,
+    sync: false,
+    async: true,
+  },
   "passport" => {
     description: "Passport",
     doc_class: Mindee::Product::Passport::PassportV1,

data/docs/bank_account_details_v2.md

@@ -134,4 +134,4 @@ puts result.document.inference.prediction.swift_code.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/bank_check_v1.md

@@ -179,4 +179,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/bank_statement_fr_v1.md

@@ -172,4 +172,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/barcode_reader_v1.md

@@ -101,4 +101,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/carte_grise_v1.md

@@ -451,4 +451,4 @@ puts result.document.inference.prediction.y6.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/carte_vitale_v1.md

@@ -120,4 +120,4 @@ puts result.document.inference.prediction.surname.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/code_samples/resume_v1_async.txt

@@ -0,0 +1,19 @@
+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::Resume::ResumeV1
+)
+
+# 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

data/docs/cropper_v1.md

@@ -97,4 +97,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/custom_v1.md

@@ -106,4 +106,4 @@ console.log(result.document.inference.prediction.classifications["my-classificat
 
 # Questions?
 
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/eu_driver_license_v1.md

@@ -1,10 +1,10 @@
 ---
-title: EU EU Driver License OCR Ruby
+title: EU Driver License OCR Ruby
 ---
-The Ruby OCR SDK supports the [EU Driver License API](https://platform.mindee.com/mindee/eu_driver_license).
+The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/eu_driver_license).
 
 Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![EU Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg?raw=true)
+![Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/eu_driver_license/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
@@ -115,7 +115,7 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 Some fields are constrained to the page level, and so will not be retrievable to through the document.
 
 # Attributes
-The following fields are extracted for EU Driver License V1:
+The following fields are extracted for Driver License V1:
 
 ## Address
 **address** ([StringField](#string-field)): EU driver license holders address
@@ -220,4 +220,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/expense_receipts_v5.md

@@ -303,4 +303,4 @@ puts result.document.inference.prediction.total_tax.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/financial_document_v1.md

@@ -392,4 +392,4 @@ puts result.document.inference.prediction.total_tax.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/generated_v1.md

@@ -87,4 +87,4 @@ puts result.document.inference.prediction.fields["my-field"].to_s
 
 # Questions?
 
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/getting_started.md

@@ -319,4 +319,4 @@ input_source = mindee_client.source_from_file(input_file, "name-of-my-file.ext",
 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-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/idcard_fr_v2.md

@@ -250,4 +250,4 @@ puts result.document.inference.prediction.surname.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/international_id_v2.md

@@ -0,0 +1,195 @@
+---
+title: International ID OCR Ruby
+---
+The Ruby OCR SDK supports the [International ID API](https://platform.mindee.com/mindee/international_id).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![International ID sample](https://github.com/mindee/client-lib-test-data/blob/main/products/international_id/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::InternationalId::InternationalIdV2
+)
+
+# 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
+```
+
+# 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, is `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 International ID V2:
+
+## Address
+**address** ([StringField](#string-field)): The physical address of the document holder.
+
+```rb
+puts result.document.inference.prediction.address.value
+```
+
+## Birth Date
+**birth_date** ([DateField](#date-field)): The date of birth of the document holder.
+
+```rb
+puts result.document.inference.prediction.birth_date.value
+```
+
+## Birth Place
+**birth_place** ([StringField](#string-field)): The place of birth of the document holder.
+
+```rb
+puts result.document.inference.prediction.birth_place.value
+```
+
+## Country of Issue
+**country_of_issue** ([StringField](#string-field)): The country where the document was issued.
+
+```rb
+puts result.document.inference.prediction.country_of_issue.value
+```
+
+## Document Number
+**document_number** ([StringField](#string-field)): The unique identifier assigned to the document.
+
+```rb
+puts result.document.inference.prediction.document_number.value
+```
+
+## Document Type
+**document_type** ([ClassificationField](#classification-field)): The type of personal identification document.
+
+```rb
+puts result.document.inference.prediction.document_type.value
+```
+
+## Expiration Date
+**expiry_date** ([DateField](#date-field)): The date when the document becomes invalid.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## Given Names
+**given_names** (Array<[StringField](#string-field)>): The list of the document holder's given names.
+
+```rb
+for given_names_elem in result.document.inference.prediction.given_names do
+  puts given_names_elem.value
+end
+```
+
+## Issue Date
+**issue_date** ([DateField](#date-field)): The date when the document was issued.
+
+```rb
+puts result.document.inference.prediction.issue_date.value
+```
+
+## MRZ Line 1
+**mrz_line1** ([StringField](#string-field)): The Machine Readable Zone, first line.
+
+```rb
+puts result.document.inference.prediction.mrz_line1.value
+```
+
+## MRZ Line 2
+**mrz_line2** ([StringField](#string-field)): The Machine Readable Zone, second line.
+
+```rb
+puts result.document.inference.prediction.mrz_line2.value
+```
+
+## MRZ Line 3
+**mrz_line3** ([StringField](#string-field)): The Machine Readable Zone, third line.
+
+```rb
+puts result.document.inference.prediction.mrz_line3.value
+```
+
+## Nationality
+**nationality** ([StringField](#string-field)): The country of citizenship of the document holder.
+
+```rb
+puts result.document.inference.prediction.nationality.value
+```
+
+## Personal Number
+**personal_number** ([StringField](#string-field)): The unique identifier assigned to the document holder.
+
+```rb
+puts result.document.inference.prediction.personal_number.value
+```
+
+## Sex
+**sex** ([StringField](#string-field)): The biological sex of the document holder.
+
+```rb
+puts result.document.inference.prediction.sex.value
+```
+
+## State of Issue
+**state_of_issue** ([StringField](#string-field)): The state or territory where the document was issued.
+
+```rb
+puts result.document.inference.prediction.state_of_issue.value
+```
+
+## Surnames
+**surnames** (Array<[StringField](#string-field)>): The list of the document holder's family names.
+
+```rb
+for surnames_elem in result.document.inference.prediction.surnames do
+  puts surnames_elem.value
+end
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/invoice_splitter_v1.md

@@ -82,4 +82,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/invoices_v4.md

@@ -347,4 +347,4 @@ puts result.document.inference.prediction.total_tax.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/license_plates_v1.md

@@ -88,4 +88,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/multi_receipts_detector_v1.md

@@ -105,4 +105,4 @@ end
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/passport_v1.md

@@ -183,4 +183,4 @@ puts result.document.inference.prediction.surname.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/proof_of_address_v1.md

@@ -204,4 +204,4 @@ puts result.document.inference.prediction.recipient_name.value
 ```
 
 # Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)