mindee 3.15.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d356c6733d8a7d00973b219dbae06199040ca8d4bece4eb3906c8ec873aebf0
-  data.tar.gz: ab240a95c8538891aa4a3ef48285903daa06cebaf13f9578eff1a9675258d3bb
+  metadata.gz: 12e0bc8339961d2e6be4c5dfdc9537d34ab63f449c435275324b95c031299764
+  data.tar.gz: 24021ef9d0175075365efc9e056d67f3d553b1ad7b95a5a2876d29fcff15031c
 SHA512:
-  metadata.gz: ec71145b9604ba30c77a842a33c89c1ad4ab4c70301c3eed2292bc95803dd112ee99c964289ca88c16ddffcb6a37f63130b30a23326b4359929791d0dcef4214
-  data.tar.gz: 0c20c191f6abe4166075a1745860ba500a488294bcb59e2a28e0b61a3bcee07a25be2adfef113d045727eeaf10f935278271a7d259f78d63e580bf8eda3833f3
+  metadata.gz: df5dc07d28d67b0e1fe1c64c3123aeb3f9c8926264aed396fdd64858f8b06d6d2485745c61d15c35e0ae3f92ee6773eaacbdc86ba3256cefd7349fb0ff90533a
+  data.tar.gz: e07e7b776f21398ce3a9197fb54afef57361ffda29c198564da9ffa1fa0eea85830c7d1601177c241219bea60c61cbb9cbcec66ad0c80d55ffcc7aab0e8cfe4f

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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
+* :sparkles: add support for delivery note V1.1
+* :sparkles: add support for indian passport V1
+* :sparkles: add support for resume V1.1
+### Fixes
+* :recycle: adjust default values for async delays
+
+
 ## v3.15.0 - 2024-10-29
 ### Changes
 * :sparkles: add support for image compression

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/business_card_v1.md

@@ -0,0 +1,169 @@
+---
+title: Business Card OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-business-card-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Business Card API](https://platform.mindee.com/mindee/business_card).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Business Card sample](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/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::BusinessCard::BusinessCardV1
+)
+
+# 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: 6f9a261f-7609-4687-9af0-46a45156566e
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/business_card v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Firstname: Andrew
+:Lastname: Morin
+:Job Title: Founder & CEO
+:Company: RemoteGlobal
+:Email: amorin@remoteglobalconsulting.com
+:Phone Number: +14015555555
+:Mobile Number: +13015555555
+:Fax Number: +14015555556
+:Address: 178 Main Avenue, Providence, RI 02111
+:Website: www.remoteglobalconsulting.com
+:Social Media: https://www.linkedin.com/in/johndoe
+               https://twitter.com/johndoe
+```
+
+# 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.
+
+### 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 Business Card V1:
+
+## Address
+**address** ([StringField](#string-field)): The address of the person.
+
+```rb
+puts result.document.inference.prediction.address.value
+```
+
+## Company
+**company** ([StringField](#string-field)): The company the person works for.
+
+```rb
+puts result.document.inference.prediction.company.value
+```
+
+## Email
+**email** ([StringField](#string-field)): The email address of the person.
+
+```rb
+puts result.document.inference.prediction.email.value
+```
+
+## Fax Number
+**fax_number** ([StringField](#string-field)): The Fax number of the person.
+
+```rb
+puts result.document.inference.prediction.fax_number.value
+```
+
+## Firstname
+**firstname** ([StringField](#string-field)): The given name of the person.
+
+```rb
+puts result.document.inference.prediction.firstname.value
+```
+
+## Job Title
+**job_title** ([StringField](#string-field)): The job title of the person.
+
+```rb
+puts result.document.inference.prediction.job_title.value
+```
+
+## Lastname
+**lastname** ([StringField](#string-field)): The lastname of the person.
+
+```rb
+puts result.document.inference.prediction.lastname.value
+```
+
+## Mobile Number
+**mobile_number** ([StringField](#string-field)): The mobile number of the person.
+
+```rb
+puts result.document.inference.prediction.mobile_number.value
+```
+
+## Phone Number
+**phone_number** ([StringField](#string-field)): The phone number of the person.
+
+```rb
+puts result.document.inference.prediction.phone_number.value
+```
+
+## Social Media
+**social_media** (Array<[StringField](#string-field)>): The social media profiles of the person or company.
+
+```rb
+for social_media_elem in result.document.inference.prediction.social_media do
+  puts social_media_elem.value
+end
+```
+
+## Website
+**website** ([StringField](#string-field)): The website of the person or company.
+
+```rb
+puts result.document.inference.prediction.website.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/code_samples/{international_id_v1_async.txt → business_card_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::BusinessCard::BusinessCardV1
 )
 
 # Print a full summary of the parsed data in RST format

data/docs/code_samples/delivery_notes_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::DeliveryNote::DeliveryNoteV1
+)
+
+# 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/driver_license_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::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

data/docs/code_samples/expense_receipts_v5_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::Receipt::ReceiptV5
+)
+
+# 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/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/ind_passport_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::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

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/delivery_notes_v1.md

@@ -0,0 +1,143 @@
+---
+title: Delivery note OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-delivery-note-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Delivery note API](https://platform.mindee.com/mindee/delivery_notes).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/delivery_notes/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Delivery note sample](https://github.com/mindee/client-lib-test-data/blob/main/products/delivery_notes/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::DeliveryNote::DeliveryNoteV1
+)
+
+# 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: d5ead821-edec-4d31-a69a-cf3998d9a506
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/delivery_notes v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:Delivery Date: 2019-10-02
+:Delivery Number: INT-001
+:Supplier Name: John Smith
+:Supplier Address: 4490 Oak Drive, Albany, NY 12210
+:Customer Name: Jessie M Horne
+:Customer Address: 4312 Wood Road, New York, NY 10031
+:Total Amount: 204.75
+```
+
+# 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.
+
+
+### Amount Field
+The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
+
+### 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 Delivery note V1:
+
+## Customer Address
+**customer_address** ([StringField](#string-field)): The address of the customer receiving the goods.
+
+```rb
+puts result.document.inference.prediction.customer_address.value
+```
+
+## Customer Name
+**customer_name** ([StringField](#string-field)): The name of the customer receiving the goods.
+
+```rb
+puts result.document.inference.prediction.customer_name.value
+```
+
+## Delivery Date
+**delivery_date** ([DateField](#date-field)): The date on which the delivery is scheduled to arrive.
+
+```rb
+puts result.document.inference.prediction.delivery_date.value
+```
+
+## Delivery Number
+**delivery_number** ([StringField](#string-field)): A unique identifier for the delivery note.
+
+```rb
+puts result.document.inference.prediction.delivery_number.value
+```
+
+## Supplier Address
+**supplier_address** ([StringField](#string-field)): The address of the supplier providing the goods.
+
+```rb
+puts result.document.inference.prediction.supplier_address.value
+```
+
+## Supplier Name
+**supplier_name** ([StringField](#string-field)): The name of the supplier providing the goods.
+
+```rb
+puts result.document.inference.prediction.supplier_name.value
+```
+
+## Total Amount
+**total_amount** ([AmountField](#amount-field)): The total monetary value of the goods being delivered.
+
+```rb
+puts result.document.inference.prediction.total_amount.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)