mindee 3.12.0 → 3.13.0

data/docs/energy_bill_fra_v1.md

@@ -0,0 +1,249 @@
+---
+title: FR Energy Bill OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-energy-bill-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
+---
+The Ruby OCR SDK supports the [Energy Bill API](https://platform.mindee.com/mindee/energy_bill_fra).
+
+The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/default_sample.jpg) can be used for testing purposes.
+![Energy Bill sample](https://github.com/mindee/client-lib-test-data/blob/main/products/energy_bill_fra/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::FR::EnergyBill::EnergyBillV1
+)
+
+# 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.
+
+
+### 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`).
+
+## Specific Fields
+Fields which are specific to this product; they are not used in any other product.
+
+### Energy Consumer Field
+The entity that consumes the energy.
+
+A `EnergyBillV1EnergyConsumer` implements the following attributes:
+
+* `address` (String): The address of the energy consumer.
+* `name` (String): The name of the energy consumer.
+Fields which are specific to this product; they are not used in any other product.
+
+### Energy Supplier Field
+The company that supplies the energy.
+
+A `EnergyBillV1EnergySupplier` implements the following attributes:
+
+* `address` (String): The address of the energy supplier.
+* `name` (String): The name of the energy supplier.
+Fields which are specific to this product; they are not used in any other product.
+
+### Energy Usage Field
+Details of energy consumption.
+
+A `EnergyBillV1EnergyUsage` implements the following attributes:
+
+* `description` (String): Description or details of the energy usage.
+* `end_date` (String): The end date of the energy usage.
+* `start_date` (String): The start date of the energy usage.
+* `tax_rate` (Float): The rate of tax applied to the total cost.
+* `total` (Float): The total cost of energy consumed.
+* `unit_price` (Float): The price per unit of energy consumed.
+Fields which are specific to this product; they are not used in any other product.
+
+### Meter Details Field
+Information about the energy meter.
+
+A `EnergyBillV1MeterDetail` implements the following attributes:
+
+* `meter_number` (String): The unique identifier of the energy meter.
+* `meter_type` (String): The type of energy meter.
+
+#### Possible values include:
+ - electricity
+ - gas
+ - water
+ - None
+
+* `unit` (String): The unit of measurement for energy consumption, which can be kW, m³, or L.
+Fields which are specific to this product; they are not used in any other product.
+
+### Subscription Field
+The subscription details fee for the energy service.
+
+A `EnergyBillV1Subscription` implements the following attributes:
+
+* `description` (String): Description or details of the subscription.
+* `end_date` (String): The end date of the subscription.
+* `start_date` (String): The start date of the subscription.
+* `tax_rate` (Float): The rate of tax applied to the total cost.
+* `total` (Float): The total cost of subscription.
+* `unit_price` (Float): The price per unit of subscription.
+Fields which are specific to this product; they are not used in any other product.
+
+### Taxes and Contributions Field
+Details of Taxes and Contributions.
+
+A `EnergyBillV1TaxesAndContribution` implements the following attributes:
+
+* `description` (String): Description or details of the Taxes and Contributions.
+* `end_date` (String): The end date of the Taxes and Contributions.
+* `start_date` (String): The start date of the Taxes and Contributions.
+* `tax_rate` (Float): The rate of tax applied to the total cost.
+* `total` (Float): The total cost of Taxes and Contributions.
+* `unit_price` (Float): The price per unit of Taxes and Contributions.
+
+# Attributes
+The following fields are extracted for Energy Bill V1:
+
+## Contract ID
+**contract_id** ([StringField](#string-field)): The unique identifier associated with a specific contract.
+
+```rb
+puts result.document.inference.prediction.contract_id.value
+```
+
+## Delivery Point
+**delivery_point** ([StringField](#string-field)): The unique identifier assigned to each electricity or gas consumption point. It specifies the exact location where the energy is delivered.
+
+```rb
+puts result.document.inference.prediction.delivery_point.value
+```
+
+## Due Date
+**due_date** ([DateField](#date-field)): The date by which the payment for the energy invoice is due.
+
+```rb
+puts result.document.inference.prediction.due_date.value
+```
+
+## Energy Consumer
+**energy_consumer** ([EnergyBillV1EnergyConsumer](#energy-consumer-field)): The entity that consumes the energy.
+
+```rb
+puts result.document.inference.prediction.energy_consumer.value
+```
+
+## Energy Supplier
+**energy_supplier** ([EnergyBillV1EnergySupplier](#energy-supplier-field)): The company that supplies the energy.
+
+```rb
+puts result.document.inference.prediction.energy_supplier.value
+```
+
+## Energy Usage
+**energy_usage** (Array<[EnergyBillV1EnergyUsage](#energy-usage-field)>): Details of energy consumption.
+
+```rb
+for energy_usage_elem in result.document.inference.prediction.energy_usage do
+  puts energy_usage_elem.value
+end
+```
+
+## Invoice Date
+**invoice_date** ([DateField](#date-field)): The date when the energy invoice was issued.
+
+```rb
+puts result.document.inference.prediction.invoice_date.value
+```
+
+## Invoice Number
+**invoice_number** ([StringField](#string-field)): The unique identifier of the energy invoice.
+
+```rb
+puts result.document.inference.prediction.invoice_number.value
+```
+
+## Meter Details
+**meter_details** ([EnergyBillV1MeterDetail](#meter-details-field)): Information about the energy meter.
+
+```rb
+puts result.document.inference.prediction.meter_details.value
+```
+
+## Subscription
+**subscription** (Array<[EnergyBillV1Subscription](#subscription-field)>): The subscription details fee for the energy service.
+
+```rb
+for subscription_elem in result.document.inference.prediction.subscription do
+  puts subscription_elem.value
+end
+```
+
+## Taxes and Contributions
+**taxes_and_contributions** (Array<[EnergyBillV1TaxesAndContribution](#taxes-and-contributions-field)>): Details of Taxes and Contributions.
+
+```rb
+for taxes_and_contributions_elem in result.document.inference.prediction.taxes_and_contributions do
+  puts taxes_and_contributions_elem.value
+end
+```
+
+## Total Amount
+**total_amount** ([AmountField](#amount-field)): The total amount to be paid for the energy invoice.
+
+```rb
+puts result.document.inference.prediction.total_amount.value
+```
+
+## Total Before Taxes
+**total_before_taxes** ([AmountField](#amount-field)): The total amount to be paid for the energy invoice before taxes.
+
+```rb
+puts result.document.inference.prediction.total_before_taxes.value
+```
+
+## Total Taxes
+**total_taxes** ([AmountField](#amount-field)): Total of taxes applied to the invoice.
+
+```rb
+puts result.document.inference.prediction.total_taxes.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/eu_driver_license_v1.md

@@ -1,5 +1,8 @@
 ---
 title: EU Driver License OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-eu-driver-license-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Driver License API](https://platform.mindee.com/mindee/eu_driver_license).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -90,7 +94,7 @@ A typical `Field` object will have the following attributes:
 * **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.
+* **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).
 
 
@@ -112,7 +116,7 @@ The position field `PositionField` does not implement all the basic `Field` attr
 The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Driver License V1:

data/docs/expense_receipts_v5.md

@@ -1,5 +1,8 @@
 ---
 title: Receipt OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-receipt-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Receipt API](https://platform.mindee.com/mindee/expense_receipts).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -120,7 +124,7 @@ A typical `Field` object will have the following attributes:
 * **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.
+* **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).
 
 
@@ -189,6 +193,16 @@ The following fields are extracted for Receipt V5:
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
+#### Possible values include:
+ - toll
+ - food
+ - parking
+ - transport
+ - accommodation
+ - gasoline
+ - telecom
+ - miscellaneous
+
 ```rb
 puts result.document.inference.prediction.category.value
 ```
@@ -203,6 +217,10 @@ puts result.document.inference.prediction.date.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
+#### Possible values include:
+ - expense_receipt
+ - credit_card_receipt
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```
@@ -233,6 +251,13 @@ puts result.document.inference.prediction.receipt_number.value
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
+#### Possible values include:
+ - plane
+ - taxi
+ - train
+ - restaurant
+ - shopping
+
 ```rb
 puts result.document.inference.prediction.subcategory.value
 ```

data/docs/financial_document_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Financial Document OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-financial-document-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Financial Document API](https://platform.mindee.com/mindee/financial_document).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 You can also call this product asynchronously:
@@ -51,6 +55,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -176,7 +181,7 @@ A typical `Field` object will have the following attributes:
 * **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.
+* **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).
 
 
@@ -264,6 +269,16 @@ puts result.document.inference.prediction.billing_address.value
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
+#### Possible values include:
+ - toll
+ - food
+ - parking
+ - transport
+ - accommodation
+ - gasoline
+ - telecom
+ - miscellaneous
+
 ```rb
 puts result.document.inference.prediction.category.value
 ```
@@ -315,6 +330,12 @@ puts result.document.inference.prediction.document_number.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
+#### Possible values include:
+ - INVOICE
+ - CREDIT NOTE
+ - CREDIT CARD RECEIPT
+ - EXPENSE RECEIPT
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```
@@ -375,6 +396,13 @@ puts result.document.inference.prediction.shipping_address.value
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
+#### Possible values include:
+ - plane
+ - taxi
+ - train
+ - restaurant
+ - shopping
+
 ```rb
 puts result.document.inference.prediction.subcategory.value
 ```

data/docs/generated_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Generated API Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-generated-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports generated APIs.
 Generated APIs can theoretically support all APIs in a catch-all generic format.

data/docs/getting_started.md

@@ -1,5 +1,8 @@
 ---
 title: Ruby Getting Started
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-getting-started
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 This guide will help you get the most out of the Mindee Ruby client library to easily extract data from your documents.
 

data/docs/idcard_fr_v2.md

@@ -1,5 +1,8 @@
 ---
 title: FR Carte Nationale d'Identité OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-fr-carte-nationale-didentite-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Carte Nationale d'Identité API](https://platform.mindee.com/mindee/idcard_fr).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -98,7 +102,7 @@ A typical `Field` object will have the following attributes:
 * **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.
+* **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).
 
 
@@ -119,7 +123,7 @@ 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`).
 
 ## Page-Level Fields
-Some fields are constrained to the page level, and so will not be retrievable to through the document.
+Some fields are constrained to the page level, and so will not be retrievable at document level.
 
 # Attributes
 The following fields are extracted for Carte Nationale d'Identité V2:
@@ -169,6 +173,11 @@ puts result.document.inference.prediction.document_number.value
 ## Document Sides
 [📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classification-field)): The sides of the document which are visible.
 
+#### Possible values include:
+ - RECTO
+ - VERSO
+ - RECTO & VERSO
+
 ```rb
 for document_side_elem in result.document.document_side do
   puts document_side_elem.value
@@ -178,6 +187,10 @@ end
 ## Document Type
 [📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classification-field)): The document type or format.
 
+#### Possible values include:
+ - NEW
+ - OLD
+
 ```rb
 for document_type_elem in result.document.document_type do
   puts document_type_elem.value

data/docs/international_id_v2.md

@@ -1,5 +1,8 @@
 ---
 title: International ID OCR Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-international-id-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [International ID API](https://platform.mindee.com/mindee/international_id).
 
@@ -27,6 +30,7 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
+
 ```
 
 **Output (RST):**
@@ -76,7 +80,7 @@ A typical `Field` object will have the following attributes:
 * **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.
+* **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).
 
 
@@ -137,6 +141,14 @@ puts result.document.inference.prediction.document_number.value
 ## Document Type
 **document_type** ([ClassificationField](#classification-field)): The type of personal identification document.
 
+#### Possible values include:
+ - IDENTIFICATION_CARD
+ - PASSPORT
+ - DRIVER_LICENSE
+ - VISA
+ - RESIDENCY_CARD
+ - VOTER_REGISTRATION
+
 ```rb
 puts result.document.inference.prediction.document_type.value
 ```

data/docs/invoice_splitter_v1.md

@@ -1,5 +1,8 @@
 ---
 title: Invoice Splitter API Ruby
+category: 622b805aaec68102ea7fcbc2
+slug: ruby-invoice-splitter-ocr
+parentDoc: 6294d97ee723f1008d2ab28e
 ---
 The Ruby OCR SDK supports the [Invoice Splitter API](https://platform.mindee.com/mindee/invoice_splitter).
 
@@ -33,30 +36,30 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
-:Filename: default_sample.jpg
+:Mindee ID: 15ad7a19-7b75-43d0-b0c6-9a641a12b49b
+:Filename: default_sample.pdf
 
 Inference
 #########
-:Product: mindee/carte_vitale v1.0
-:Rotation applied: Yes
+:Product: mindee/invoice_splitter v1.1
+:Rotation applied: No
 
 Prediction
 ==========
-:Given Name(s): NATHALIE
-:Surname: DURAND
-:Social Security Number: 269054958815780
-:Issuance Date: 2007-01-01
+:Invoice Page Groups:
+  :Page indexes: 0
+  :Page indexes: 1
 
 Page Predictions
 ================
 
 Page 0
 ------
-:Given Name(s): NATHALIE
-:Surname: DURAND
-:Social Security Number: 269054958815780
-:Issuance Date: 2007-01-01
+:Invoice Page Groups:
+
+Page 1
+------
+:Invoice Page Groups:
 ```
 
 # Field Types
@@ -77,7 +80,7 @@ The following fields are extracted for Invoice Splitter V1:
 
 ```rb
 for invoice_page_groups_elem in result.document.inference.prediction.invoice_page_groups do 
-  puts invoicePageGroupsElem.pageIndexes.join(', ')
+  puts invoice_page_groups_elem.page_indexes.join(', ')
 end
 ```