mindee 3.14.0 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '043953eb35ed9f251d12ca8b984edcf9acbeb491689574450dc3682b83e9db37'
-  data.tar.gz: 5916ad8aeada6713ee5a846d634693fd1ed5e585495238649f9a9c1d2e9fbd00
+  metadata.gz: c91223f916a74a5224df6a5df5557d2fdebcfe4dd70c2a8ed76db1ab4b8abdda
+  data.tar.gz: 39667d73103146ce8fc1de4d49489a4be0062b5651cacb854334443ef0d90a0d
 SHA512:
-  metadata.gz: 7edd036d9666e1ffe0318b8ec68cdfe5b37b6bdbb90e36ae0c19efa5cc038f109af30d9e6df6838e4237db2f9495a6251f10164db7e0c7dff528720ef4477a2a
-  data.tar.gz: 7dfbb27c5175bda760ba816be62b1447acf4517d6741506cb458bbe4b2b4c77338eff1d799d19f4b0bdca663323523eb479bc468e80f9ed1943226694ef04143
+  metadata.gz: 5be6ee28449e4a74d99e2fb172e47fccb75fc11e92f233b35aec0c8fb50b76cca53054c47fd3edafa330a34dab080b10e680f94f086c98eef1a5bcbcc219c77d
+  data.tar.gz: 4d859af23946ad75890c6bca1bb947903c649dc31a3e37ff9b4557dd5b0ac999cd2ec4f9f81c09d584d033a61b6adb743130ea3be9e08da89df6e507280f9a22

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Mindee Ruby API Library Changelog
 
+## 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
+* :sparkles: add support for PDF compression
+### Fixes
+* :recycle: refactor pdf & image namespaces
+* :memo: fix rubocop directives unexpectedly appearing in Yard documentation
+* :arrow_up: bump version for mini_magick
+
+
 ## v3.14.0 - 2024-10-11
 ### Changes
 * :sparkles: add support for Financial Document v1.10

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/business_card_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::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

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/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/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/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)

data/docs/energy_bill_fra_v1.md

@@ -6,8 +6,8 @@ parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
 
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg?raw=true)
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.pdf), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.pdf?raw=true)
 
 # Quick-Start
 ```rb

data/docs/expense_receipts_v5.md

@@ -33,6 +33,31 @@ puts result.document
 
 ```
 
+You can also call this product asynchronously:
+
+```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::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
+
+```
+
 **Output (RST):**
 ```rst
 ########
@@ -50,7 +75,7 @@ Prediction
 ==========
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory:
+:Purchase Subcategory: restaurant
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20
@@ -84,7 +109,7 @@ Page 0
 ------
 :Expense Locale: en-GB; en; GB; GBP;
 :Purchase Category: food
-:Purchase Subcategory:
+:Purchase Subcategory: restaurant
 :Document Type: EXPENSE RECEIPT
 :Purchase Date: 2016-02-26
 :Purchase Time: 15:20

data/docs/financial_document_v1.md

@@ -63,23 +63,25 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 3859a462-e05f-4f4c-a736-febca66b9aa9
+:Mindee ID: b26161ce-35d0-4984-b1ff-886645e160e6
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.9
+:Product: mindee/financial_document v1.11
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; USD;
+:Locale: en-US; en; US; USD;
 :Invoice Number: INT-001
+:Purchase Order Number: 2412/2019
 :Receipt Number:
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
+:Payment Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes:
@@ -123,13 +125,15 @@ Page Predictions
 
 Page 0
 ------
-:Locale: en; en; USD;
+:Locale: en-US; en; US; USD;
 :Invoice Number: INT-001
+:Purchase Order Number: 2412/2019
 :Receipt Number:
 :Document Number: INT-001
 :Reference Numbers: 2412/2019
 :Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
+:Payment Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
 :Taxes: