mindee 3.16.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c91223f916a74a5224df6a5df5557d2fdebcfe4dd70c2a8ed76db1ab4b8abdda
-  data.tar.gz: 39667d73103146ce8fc1de4d49489a4be0062b5651cacb854334443ef0d90a0d
+  metadata.gz: 12e0bc8339961d2e6be4c5dfdc9537d34ab63f449c435275324b95c031299764
+  data.tar.gz: 24021ef9d0175075365efc9e056d67f3d553b1ad7b95a5a2876d29fcff15031c
 SHA512:
-  metadata.gz: 5be6ee28449e4a74d99e2fb172e47fccb75fc11e92f233b35aec0c8fb50b76cca53054c47fd3edafa330a34dab080b10e680f94f086c98eef1a5bcbcc219c77d
-  data.tar.gz: 4d859af23946ad75890c6bca1bb947903c649dc31a3e37ff9b4557dd5b0ac999cd2ec4f9f81c09d584d033a61b6adb743130ea3be9e08da89df6e507280f9a22
+  metadata.gz: df5dc07d28d67b0e1fe1c64c3123aeb3f9c8926264aed396fdd64858f8b06d6d2485745c61d15c35e0ae3f92ee6773eaacbdc86ba3256cefd7349fb0ff90533a
+  data.tar.gz: e07e7b776f21398ce3a9197fb54afef57361ffda29c198564da9ffa1fa0eea85830c7d1601177c241219bea60c61cbb9cbcec66ad0c80d55ffcc7aab0e8cfe4f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Mindee Ruby API Library Changelog
 
+## v3.17.0 - 2024-11-28
+### Changes
+* :sparkles: add support for workflows
+* :sparkles: add support for French Health Card V1
+* :sparkles: add support for Driver License V1
+* :sparkles: add support for Payslip FR V3
+* :coffin: remove support for international ID V1
+
 ## v3.16.0 - 2024-11-14
 ### Changes
 * :sparkles: add support for business cards V1

data/bin/mindee.rb

@@ -41,7 +41,7 @@ DOCUMENTS = {
     description: 'Invoice',
     doc_class: Mindee::Product::Invoice::InvoiceV4,
     sync: true,
-    async: false,
+    async: true,
   },
   "international-id" => {
     description: 'International Id',
@@ -53,7 +53,13 @@ DOCUMENTS = {
     description: "Expense Receipt",
     doc_class: Mindee::Product::Receipt::ReceiptV5,
     sync: true,
-    async: false,
+    async: true,
+  },
+  "driver-license" => {
+    description: "Driver License",
+    doc_class: Mindee::Product::DriverLicense::DriverLicenseV1,
+    sync: false,
+    async: true,
   },
   "resume" => {
     description: "Resume",
@@ -103,6 +109,18 @@ DOCUMENTS = {
     sync: true,
     async: false,
   },
+  "fr-health-card" => {
+    description: "FR Health Card",
+    doc_class: Mindee::Product::FR::HealthCard::HealthCardV1,
+    sync: false,
+    async: true,
+  },
+  "fr-payslip" => {
+    description: "FR Payslip",
+    doc_class: Mindee::Product::FR::Payslip::PayslipV3,
+    sync: false,
+    async: true,
+  },
   "us-bank-check" => {
     description: "US Bank Check",
     doc_class: Mindee::Product::US::BankCheck::BankCheckV1,

data/docs/code_samples/{international_id_v1_async.txt → driver_license_v1_async.txt}

@@ -9,7 +9,7 @@ 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::InternationalIdV1
+  Mindee::Product::DriverLicense::DriverLicenseV1
 )
 
 # Print a full summary of the parsed data in RST format

data/docs/code_samples/french_healthcard_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::FR::HealthCard::HealthCardV1
+)
+
+# 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/code_samples/payslip_fra_v3_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::FR::Payslip::PayslipV3
+)
+
+# 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/code_samples/workflow_execution.txt

@@ -0,0 +1,29 @@
+require 'mindee'
+
+workflow_id = 'workflow-id'
+
+# 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')
+
+# Send the file to the workflow
+result = mindee_client.execute_workflow(
+  input_source,
+  workflow_id
+)
+
+# Alternatively, set an alias & a priority for the execution.
+# result = mindee_client.execute_workflow(
+#   input_source,
+#   workflow_id,
+#   document_alias: "my-alias",
+#   priority: Mindee::Parsing::Common::ExecutionPriority::LOW
+# )
+
+# Print the execution's ID to make sure it worked
+puts result.execution.id
+
+# Print the inference, if present
+# puts result.document.inference

data/docs/driver_license_v1.md

@@ -0,0 +1,156 @@
+---
+title: Driver License OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-driver-license-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/driver_license).
+
+The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/default_sample.jpg) can be used for testing purposes.
+![Driver License sample](https://github.com/mindee/client-lib-test-data/blob/main/products/driver_license/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::DriverLicense::DriverLicenseV1
+)
+
+# 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
+
+```
+# 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.
+
+### 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 Driver License V1:
+
+## Category
+**category** ([StringField](#string-field)): The category or class of the driver license.
+
+```rb
+puts result.document.inference.prediction.category.value
+```
+
+## Country Code
+**country_code** ([StringField](#string-field)): The alpha-3 ISO 3166 code of the country where the driver license was issued.
+
+```rb
+puts result.document.inference.prediction.country_code.value
+```
+
+## Date of Birth
+**date_of_birth** ([DateField](#date-field)): The date of birth of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.date_of_birth.value
+```
+
+## DD Number
+**dd_number** ([StringField](#string-field)): The DD number of the driver license.
+
+```rb
+puts result.document.inference.prediction.dd_number.value
+```
+
+## Expiry Date
+**expiry_date** ([DateField](#date-field)): The expiry date of the driver license.
+
+```rb
+puts result.document.inference.prediction.expiry_date.value
+```
+
+## First Name
+**first_name** ([StringField](#string-field)): The first name of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.first_name.value
+```
+
+## ID
+**id** ([StringField](#string-field)): The unique identifier of the driver license.
+
+```rb
+puts result.document.inference.prediction.id.value
+```
+
+## Issued Date
+**issued_date** ([DateField](#date-field)): The date when the driver license was issued.
+
+```rb
+puts result.document.inference.prediction.issued_date.value
+```
+
+## Issuing Authority
+**issuing_authority** ([StringField](#string-field)): The authority that issued the driver license.
+
+```rb
+puts result.document.inference.prediction.issuing_authority.value
+```
+
+## Last Name
+**last_name** ([StringField](#string-field)): The last name of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.last_name.value
+```
+
+## MRZ
+**mrz** ([StringField](#string-field)): The Machine Readable Zone (MRZ) of the driver license.
+
+```rb
+puts result.document.inference.prediction.mrz.value
+```
+
+## Place of Birth
+**place_of_birth** ([StringField](#string-field)): The place of birth of the driver license holder.
+
+```rb
+puts result.document.inference.prediction.place_of_birth.value
+```
+
+## State
+**state** ([StringField](#string-field)): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+
+```rb
+puts result.document.inference.prediction.state.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/{carte_vitale_v1.md → french_healthcard_v1.md}

@@ -1,13 +1,13 @@
 ---
-title: FR Carte Vitale OCR Ruby
+title: FR Health Card OCR Ruby
 category: 622b805aaec68102ea7fcbc2
-slug: ruby-fr-carte-vitale-ocr
+slug: ruby-fr-health-card-ocr
 parentDoc: 6294d97ee723f1008d2ab28e
 ---
-The Ruby OCR SDK supports the [Carte Vitale API](https://platform.mindee.com/mindee/carte_vitale).
+The Ruby OCR SDK supports the [Health Card API](https://platform.mindee.com/mindee/french_healthcard).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_vitale/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![Carte Vitale sample](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_vitale/default_sample.jpg?raw=true)
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/french_healthcard/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Health Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/french_healthcard/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
@@ -20,9 +20,9 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.parse(
+result = mindee_client.enqueue_and_parse(
   input_source,
-  Mindee::Product::FR::CarteVitale::CarteVitaleV1
+  Mindee::Product::FR::HealthCard::HealthCardV1
 )
 
 # Print a full summary of the parsed data in RST format
@@ -38,29 +38,19 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
+:Mindee ID: 9ee2733d-933a-4dcd-a73a-a31395e3b288
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/carte_vitale v1.0
+:Product: mindee/french_healthcard v1.0
 :Rotation applied: Yes
 
 Prediction
 ==========
 :Given Name(s): NATHALIE
 :Surname: DURAND
-:Social Security Number: 269054958815780
-:Issuance Date: 2007-01-01
-
-Page Predictions
-================
-
-Page 0
-------
-:Given Name(s): NATHALIE
-:Surname: DURAND
-:Social Security Number: 269054958815780
+:Social Security Number: 2 69 05 49 588 157 80
 :Issuance Date: 2007-01-01
 ```
 
@@ -91,10 +81,10 @@ Aside from the basic `Field` attributes, the date field `DateField` also impleme
 The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
 
 # Attributes
-The following fields are extracted for Carte Vitale V1:
+The following fields are extracted for Health Card V1:
 
 ## Given Name(s)
-**given_names** (Array<[StringField](#string-field)>): The given name(s) of the card holder.
+**given_names** (Array<[StringField](#string-field)>): The given names of the card holder.
 
 ```rb
 for given_names_elem in result.document.inference.prediction.given_names do
@@ -103,14 +93,14 @@ end
 ```
 
 ## Issuance Date
-**issuance_date** ([DateField](#date-field)): The date the card was issued.
+**issuance_date** ([DateField](#date-field)): The date when the carte vitale document was issued.
 
 ```rb
 puts result.document.inference.prediction.issuance_date.value
 ```
 
 ## Social Security Number
-**social_security** ([StringField](#string-field)): The Social Security Number (Numéro de Sécurité Sociale) of the card holder
+**social_security** ([StringField](#string-field)): The social security number of the card holder.
 
 ```rb
 puts result.document.inference.prediction.social_security.value