mindee 3.1.1 → 3.3.0

data/docs/carte_grise_v1.md

@@ -0,0 +1,454 @@
+---
+title: FR Carte Grise OCR Ruby
+---
+The Ruby OCR SDK supports the [Carte Grise API](https://platform.mindee.com/mindee/carte_grise).
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_grise/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+![Carte Grise sample](https://github.com/mindee/client-lib-test-data/blob/main/products/carte_grise/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.parse(
+  input_source,
+  Mindee::Product::FR::CarteGrise::CarteGriseV1
+)
+
+# 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: f0e0f7a9-0f44-4a3d-92c7-5be262133d33
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/carte_grise v1.0
+:Rotation applied: Yes
+
+Prediction
+==========
+:a: AB-123-CD
+:b: 1998-01-05
+:c1: DUPONT YVES
+:c3: 27 RUE DES ROITELETS 59169 FERIN LES BAINS FRANCE
+:c41: 2 DELAROCHE
+:c4a: EST LE PROPRIETAIRE DU VEHICULE
+:d1:
+:d3: MODELE
+:e: VFS1V2009AS1V2009
+:f1: 1915
+:f2: 1915
+:f3: 1915
+:g: 3030
+:g1: 1307
+:i: 2009-12-04
+:j: N1
+:j1: VP
+:j2: AA
+:j3: CI
+:p1: 1900
+:p2: 90
+:p3: GO
+:p6: 6
+:q:
+:s1: 5
+:s2:
+:u1: 77
+:u2: 3000
+:v7: 155
+:x1: 2011-07-06
+:y1:
+:y2:
+:y3: 0
+:y4: 4
+:y5: 2.5
+:y6: 178.35
+:Formula Number: 2009AS05284
+:Owner's First Name: YVES
+:Owner's Surname: DUPONT
+:MRZ Line 1:
+:MRZ Line 2: CI<<MARQUES<<<<<<<MODELE<<<<<<<2009AS0528402
+
+Page Predictions
+================
+
+Page 0
+------
+:a: AB-123-CD
+:b: 1998-01-05
+:c1: DUPONT YVES
+:c3: 27 RUE DES ROITELETS 59169 FERIN LES BAINS FRANCE
+:c41: 2 DELAROCHE
+:c4a: EST LE PROPRIETAIRE DU VEHICULE
+:d1:
+:d3: MODELE
+:e: VFS1V2009AS1V2009
+:f1: 1915
+:f2: 1915
+:f3: 1915
+:g: 3030
+:g1: 1307
+:i: 2009-12-04
+:j: N1
+:j1: VP
+:j2: AA
+:j3: CI
+:p1: 1900
+:p2: 90
+:p3: GO
+:p6: 6
+:q: 006
+:s1: 5
+:s2:
+:u1: 77
+:u2: 3000
+:v7: 155
+:x1: 2011-07-06
+:y1: 17835
+:y2:
+:y3: 0
+:y4: 4
+:y5: 2.5
+:y6: 178.35
+:Formula Number: 2009AS05284
+:Owner's First Name: YVES
+:Owner's Surname: DUPONT
+:MRZ Line 1:
+:MRZ Line 2: CI<<MARQUES<<<<<<<MODELE<<<<<<<2009AS0528402
+```
+
+# 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 or not 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 Carte Grise V1:
+
+## a
+**a** ([StringField](#string-field)): The vehicle's license plate number.
+
+```rb
+puts result.document.inference.prediction.a.value
+```
+
+## b
+**b** ([DateField](#date-field)): The vehicle's first release date.
+
+```rb
+puts result.document.inference.prediction.b.value
+```
+
+## c1
+**c1** ([StringField](#string-field)): The vehicle owner's full name including maiden name.
+
+```rb
+puts result.document.inference.prediction.c1.value
+```
+
+## c3
+**c3** ([StringField](#string-field)): The vehicle owner's address.
+
+```rb
+puts result.document.inference.prediction.c3.value
+```
+
+## c41
+**c41** ([StringField](#string-field)): Number of owners of the license certificate.
+
+```rb
+puts result.document.inference.prediction.c41.value
+```
+
+## c4a
+**c4a** ([StringField](#string-field)): Mentions about the ownership of the vehicle.
+
+```rb
+puts result.document.inference.prediction.c4a.value
+```
+
+## d1
+**d1** ([StringField](#string-field)): The vehicle's brand.
+
+```rb
+puts result.document.inference.prediction.d1.value
+```
+
+## d3
+**d3** ([StringField](#string-field)): The vehicle's commercial name.
+
+```rb
+puts result.document.inference.prediction.d3.value
+```
+
+## e
+**e** ([StringField](#string-field)): The Vehicle Identification Number (VIN).
+
+```rb
+puts result.document.inference.prediction.e.value
+```
+
+## f1
+**f1** ([StringField](#string-field)): The vehicle's maximum admissible weight.
+
+```rb
+puts result.document.inference.prediction.f1.value
+```
+
+## f2
+**f2** ([StringField](#string-field)): The vehicle's maximum admissible weight within the license's state.
+
+```rb
+puts result.document.inference.prediction.f2.value
+```
+
+## f3
+**f3** ([StringField](#string-field)): The vehicle's maximum authorized weight with coupling.
+
+```rb
+puts result.document.inference.prediction.f3.value
+```
+
+## Formula Number
+**formula_number** ([StringField](#string-field)): The document's formula number.
+
+```rb
+puts result.document.inference.prediction.formula_number.value
+```
+
+## g
+**g** ([StringField](#string-field)): The vehicle's weight with coupling if tractor different than category M1.
+
+```rb
+puts result.document.inference.prediction.g.value
+```
+
+## g1
+**g1** ([StringField](#string-field)): The vehicle's national empty weight.
+
+```rb
+puts result.document.inference.prediction.g1.value
+```
+
+## i
+**i** ([DateField](#date-field)): The car registration date of the given certificate.
+
+```rb
+puts result.document.inference.prediction.i.value
+```
+
+## j
+**j** ([StringField](#string-field)): The vehicle's category.
+
+```rb
+puts result.document.inference.prediction.j.value
+```
+
+## j1
+**j1** ([StringField](#string-field)): The vehicle's national type.
+
+```rb
+puts result.document.inference.prediction.j1.value
+```
+
+## j2
+**j2** ([StringField](#string-field)): The vehicle's body type (CE).
+
+```rb
+puts result.document.inference.prediction.j2.value
+```
+
+## j3
+**j3** ([StringField](#string-field)): The vehicle's body type (National designation).
+
+```rb
+puts result.document.inference.prediction.j3.value
+```
+
+## MRZ Line 1
+**mrz1** ([StringField](#string-field)): Machine Readable Zone, first line.
+
+```rb
+puts result.document.inference.prediction.mrz1.value
+```
+
+## MRZ Line 2
+**mrz2** ([StringField](#string-field)): Machine Readable Zone, second line.
+
+```rb
+puts result.document.inference.prediction.mrz2.value
+```
+
+## Owner's First Name
+**owner_first_name** ([StringField](#string-field)): The vehicle's owner first name.
+
+```rb
+puts result.document.inference.prediction.owner_first_name.value
+```
+
+## Owner's Surname
+**owner_surname** ([StringField](#string-field)): The vehicle's owner surname.
+
+```rb
+puts result.document.inference.prediction.owner_surname.value
+```
+
+## p1
+**p1** ([StringField](#string-field)): The vehicle engine's displacement (cm3).
+
+```rb
+puts result.document.inference.prediction.p1.value
+```
+
+## p2
+**p2** ([StringField](#string-field)): The vehicle's maximum net power (kW).
+
+```rb
+puts result.document.inference.prediction.p2.value
+```
+
+## p3
+**p3** ([StringField](#string-field)): The vehicle's fuel type or energy source.
+
+```rb
+puts result.document.inference.prediction.p3.value
+```
+
+## p6
+**p6** ([StringField](#string-field)): The vehicle's administrative power (fiscal horsepower).
+
+```rb
+puts result.document.inference.prediction.p6.value
+```
+
+## q
+**q** ([StringField](#string-field)): The vehicle's power to weight ratio.
+
+```rb
+puts result.document.inference.prediction.q.value
+```
+
+## s1
+**s1** ([StringField](#string-field)): The vehicle's number of seats.
+
+```rb
+puts result.document.inference.prediction.s1.value
+```
+
+## s2
+**s2** ([StringField](#string-field)): The vehicle's number of standing rooms (person).
+
+```rb
+puts result.document.inference.prediction.s2.value
+```
+
+## u1
+**u1** ([StringField](#string-field)): The vehicle's sound level (dB).
+
+```rb
+puts result.document.inference.prediction.u1.value
+```
+
+## u2
+**u2** ([StringField](#string-field)): The vehicle engine's rotation speed (RPM).
+
+```rb
+puts result.document.inference.prediction.u2.value
+```
+
+## v7
+**v7** ([StringField](#string-field)): The vehicle's CO2 emission (g/km).
+
+```rb
+puts result.document.inference.prediction.v7.value
+```
+
+## x1
+**x1** ([StringField](#string-field)): Next technical control date.
+
+```rb
+puts result.document.inference.prediction.x1.value
+```
+
+## y1
+**y1** ([StringField](#string-field)): Amount of the regional proportional tax of the registration (in euros).
+
+```rb
+puts result.document.inference.prediction.y1.value
+```
+
+## y2
+**y2** ([StringField](#string-field)): Amount of the additional parafiscal tax of the registration (in euros).
+
+```rb
+puts result.document.inference.prediction.y2.value
+```
+
+## y3
+**y3** ([StringField](#string-field)): Amount of the additional CO2 tax of the registration (in euros).
+
+```rb
+puts result.document.inference.prediction.y3.value
+```
+
+## y4
+**y4** ([StringField](#string-field)): Amount of the fee for managing the registration (in euros).
+
+```rb
+puts result.document.inference.prediction.y4.value
+```
+
+## y5
+**y5** ([StringField](#string-field)): Amount of the fee for delivery of the registration certificate in euros.
+
+```rb
+puts result.document.inference.prediction.y5.value
+```
+
+## y6
+**y6** ([StringField](#string-field)): Total amount of registration fee to be paid in euros.
+
+```rb
+puts result.document.inference.prediction.y6.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/docs/carte_vitale_v1.md

@@ -0,0 +1,123 @@
+---
+title: FR Carte Vitale OCR Ruby
+---
+The Ruby OCR SDK supports the [Carte Vitale API](https://platform.mindee.com/mindee/carte_vitale).
+
+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)
+
+# 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.parse(
+  input_source,
+  Mindee::Product::FR::CarteVitale::CarteVitaleV1
+)
+
+# 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: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/carte_vitale 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
+:Issuance Date: 2007-01-01
+```
+
+# 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 or not 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 Carte Vitale V1:
+
+## Given Name(s)
+**given_names** (Array<[StringField](#string-field)>): The given name(s) of the card holder.
+
+```rb
+for given_names_elem in result.document.inference.prediction.given_names do
+  puts given_names_elem.value
+end
+```
+
+## Issuance Date
+**issuance_date** ([DateField](#date-field)): The date the card 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
+
+```rb
+puts result.document.inference.prediction.social_security.value
+```
+
+## Surname
+**surname** ([StringField](#string-field)): The surname of the card holder.
+
+```rb
+puts result.document.inference.prediction.surname.value
+```
+
+# Questions?
+[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

data/docs/code_samples/barcode_reader_v1.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.parse(
+  input_source,
+  Mindee::Product::BarcodeReader::BarcodeReaderV1
+)
+
+# 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/carte_grise_v1.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.parse(
+  input_source,
+  Mindee::Product::FR::CarteGrise::CarteGriseV1
+)
+
+# 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/cropper_v1.txt

@@ -0,0 +1,16 @@
+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.parse(
+  input_source,
+  Mindee::Product::Cropper::CropperV1
+)
+
+# Print a full summary of the parsed data in RST format
+puts result.document

data/docs/code_samples/idcard_fr_v2.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.parse(
+  input_source,
+  Mindee::Product::FR::IdCard::IdCardV2
+)
+
+# 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