mindee 4.7.2 → 4.8.0

data/docs/localized_products/idcard_fr_v2.md

@@ -1,284 +0,0 @@
----
-title: FR Carte Nationale d'Identité
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-fr-carte-nationale-didentite-ocr
-parentDoc: 67b49e29a2cd6f08d69a40d8
----
-The Ruby Client Library supports the [Carte Nationale d'Identité API](https://platform.mindee.com/mindee/idcard_fr).
-
-
-> 📝 Product Specs
->
-> | Specification                  | Details                                            |
-> | ------------------------------ | -------------------------------------------------- |
-> | Endpoint Name                  | `idcard_fr`                                        |
-> | Recommended Version            | `v2.0`                                             |
-> | Supports Polling/Webhooks      | ❌ No                                              |
-> | Support Synchronous HTTP Calls | ✔️ Yes                                             |
-> | Geography                      | 🇫🇷 France                                          |
-
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/idcard_fr/default_sample.jpg),
-we are going to illustrate how to extract the data that we want using the Ruby Client Library.
-![Carte Nationale d'Identité sample](https://github.com/mindee/client-lib-test-data/blob/main/products/idcard_fr/default_sample.jpg?raw=true)
-
-# Quick-Start
-```rb
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-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
-```
-
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: d33828f1-ef7e-4984-b9df-a2bfaa38a78d
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/idcard_fr v2.0
-:Rotation applied: Yes
-
-Prediction
-==========
-:Nationality:
-:Card Access Number: 175775H55790
-:Document Number:
-:Given Name(s): Victor
-                Marie
-:Surname: DAMBARD
-:Alternate Name:
-:Date of Birth: 1994-04-24
-:Place of Birth: LYON 4E ARRONDISSEM
-:Gender: M
-:Expiry Date: 2030-04-02
-:Mrz Line 1: IDFRADAMBARD<<<<<<<<<<<<<<<<<<075025
-:Mrz Line 2: 170775H557903VICTOR<<MARIE<9404246M5
-:Mrz Line 3:
-:Date of Issue: 2015-04-03
-:Issuing Authority: SOUS-PREFECTURE DE BELLE (02)
-
-Page Predictions
-================
-
-Page 0
-------
-:Document Type: OLD
-:Document Sides: RECTO & VERSO
-:Nationality:
-:Card Access Number: 175775H55790
-:Document Number:
-:Given Name(s): Victor
-                Marie
-:Surname: DAMBARD
-:Alternate Name:
-:Date of Birth: 1994-04-24
-:Place of Birth: LYON 4E ARRONDISSEM
-:Gender: M
-:Expiry Date: 2030-04-02
-:Mrz Line 1: IDFRADAMBARD<<<<<<<<<<<<<<<<<<075025
-:Mrz Line 2: 170775H557903VICTOR<<MARIE<9404246M5
-:Mrz Line 3:
-:Date of Issue: 2015-04-03
-:Issuing Authority: SOUS-PREFECTURE DE BELLE (02)
-```
-
-# 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`, `bool`): 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** (`bool`): 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.
-
-
-### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
-**value**, **confidence** and **page_id**.
-
-> Note: a classification field's `value is always 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`).
-
-## Page-Level Fields
-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:
-
-## Alternate Name
-**alternate_name** ([StringField](#string-field)): The alternate name of the card holder.
-
-```rb
-puts result.document.inference.prediction.alternate_name.value
-```
-
-## Issuing Authority
-**authority** ([StringField](#string-field)): The name of the issuing authority.
-
-```rb
-puts result.document.inference.prediction.authority.value
-```
-
-## Date of Birth
-**birth_date** ([DateField](#date-field)): The date of birth of the card holder.
-
-```rb
-puts result.document.inference.prediction.birth_date.value
-```
-
-## Place of Birth
-**birth_place** ([StringField](#string-field)): The place of birth of the card holder.
-
-```rb
-puts result.document.inference.prediction.birth_place.value
-```
-
-## Card Access Number
-**card_access_number** ([StringField](#string-field)): The card access number (CAN).
-
-```rb
-puts result.document.inference.prediction.card_access_number.value
-```
-
-## Document Number
-**document_number** ([StringField](#string-field)): The document number.
-
-```rb
-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
-  result.document.document_side.each do |document_side_elem|
-    puts document_side_elem.value
-  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
-  result.document.document_type.each do |document_type_elem|
-    puts document_type_elem.value
-  end
-```
-
-## Expiry Date
-**expiry_date** ([DateField](#date-field)): The expiry date of the identification card.
-
-```rb
-puts result.document.inference.prediction.expiry_date.value
-```
-
-## Gender
-**gender** ([StringField](#string-field)): The gender of the card holder.
-
-```rb
-puts result.document.inference.prediction.gender.value
-```
-
-## Given Name(s)
-**given_names** (Array<[StringField](#string-field)>): The given name(s) of the card holder.
-
-```rb
-result.document.inference.prediction.given_names do |given_names_elem|
-  puts given_names_elem.value
-end
-```
-
-## Date of Issue
-**issue_date** ([DateField](#date-field)): The date of issue of the identification card.
-
-```rb
-puts result.document.inference.prediction.issue_date.value
-```
-
-## Mrz Line 1
-**mrz1** ([StringField](#string-field)): The Machine Readable Zone, first line.
-
-```rb
-puts result.document.inference.prediction.mrz1.value
-```
-
-## Mrz Line 2
-**mrz2** ([StringField](#string-field)): The Machine Readable Zone, second line.
-
-```rb
-puts result.document.inference.prediction.mrz2.value
-```
-
-## Mrz Line 3
-**mrz3** ([StringField](#string-field)): The Machine Readable Zone, third line.
-
-```rb
-puts result.document.inference.prediction.mrz3.value
-```
-
-## Nationality
-**nationality** ([StringField](#string-field)): The nationality of the card holder.
-
-```rb
-puts result.document.inference.prediction.nationality.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-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/localized_products/ind_passport_v1.md

@@ -1,307 +0,0 @@
----
-title: IND Passport - India
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-ind-passport---india-ocr
-parentDoc: 67b49e29a2cd6f08d69a40d8
----
-The Ruby Client Library supports the [Passport - India API](https://platform.mindee.com/mindee/ind_passport).
-
-
-> 📝 Product Specs
->
-> | Specification                  | Details                                            |
-> | ------------------------------ | -------------------------------------------------- |
-> | Endpoint Name                  | `ind_passport`                                     |
-> | Recommended Version            | `v1.2`                                             |
-> | Supports Polling/Webhooks      | ✔️ Yes                                             |
-> | Support Synchronous HTTP Calls | ❌ No                                              |
-> | Geography                      | 🇮🇳 India                                           |
-
-> 🔐 Polling Limitations
->
-> | Setting                         | Parameter name          | Default Value |
-> | ------------------------------- | ----------------------- | ------------- |
-> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
-> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
-> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
-
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg),
-we are going to illustrate how to extract the data that we want using the Ruby Client Library.
-![Passport - India sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg?raw=true)
-
-# Quick-Start
-```rb
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-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::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
-```
-
-**Output (RST):**
-```rst
-########
-Document
-########
-:Mindee ID: cf88fd43-eaa1-497a-ba29-a9569a4edaa7
-:Filename: default_sample.jpg
-
-Inference
-#########
-:Product: mindee/ind_passport v1.2
-:Rotation applied: Yes
-
-Prediction
-==========
-:Page Number: 1
-:Country: IND
-:ID Number: J8369854
-:Given Names: JOCELYN MICHELLE
-:Surname: DOE
-:Birth Date: 1959-09-23
-:Birth Place: GUNDUGOLANU
-:Issuance Place: HYDERABAD
-:Gender: F
-:Issuance Date: 2011-10-11
-:Expiry Date: 2021-10-10
-:MRZ Line 1: P<DOE<<JOCELYNMICHELLE<<<<<<<<<<<<<<<<<<<<<
-:MRZ Line 2: J8369854<4IND5909234F2110101<<<<<<<<<<<<<<<8
-:Legal Guardian:
-:Name of Spouse:
-:Name of Mother:
-:Old Passport Date of Issue:
-:Old Passport Number:
-:Old Passport Place of Issue:
-:Address Line 1:
-:Address Line 2:
-:Address Line 3:
-:File Number:
-```
-
-# 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`, `bool`): 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** (`bool`): 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.
-
-
-### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
-**value**, **confidence** and **page_id**.
-
-> Note: a classification field's `value is always 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 Passport - India V1:
-
-## Address Line 1
-**address1** ([StringField](#string-field)): The first line of the address of the passport holder.
-
-```rb
-puts result.document.inference.prediction.address1.value
-```
-
-## Address Line 2
-**address2** ([StringField](#string-field)): The second line of the address of the passport holder.
-
-```rb
-puts result.document.inference.prediction.address2.value
-```
-
-## Address Line 3
-**address3** ([StringField](#string-field)): The third line of the address of the passport holder.
-
-```rb
-puts result.document.inference.prediction.address3.value
-```
-
-## Birth Date
-**birth_date** ([DateField](#date-field)): The birth date of the passport holder, ISO format: YYYY-MM-DD.
-
-```rb
-puts result.document.inference.prediction.birth_date.value
-```
-
-## Birth Place
-**birth_place** ([StringField](#string-field)): The birth place of the passport holder.
-
-```rb
-puts result.document.inference.prediction.birth_place.value
-```
-
-## Country
-**country** ([StringField](#string-field)): ISO 3166-1 alpha-3 country code (3 letters format).
-
-```rb
-puts result.document.inference.prediction.country.value
-```
-
-## Expiry Date
-**expiry_date** ([DateField](#date-field)): The date when the passport will expire, ISO format: YYYY-MM-DD.
-
-```rb
-puts result.document.inference.prediction.expiry_date.value
-```
-
-## File Number
-**file_number** ([StringField](#string-field)): The file number of the passport document.
-
-```rb
-puts result.document.inference.prediction.file_number.value
-```
-
-## Gender
-**gender** ([ClassificationField](#classification-field)): The gender of the passport holder.
-
-#### Possible values include:
- - 'M'
- - 'F'
-
-```rb
-puts result.document.inference.prediction.gender.value
-```
-
-## Given Names
-**given_names** ([StringField](#string-field)): The given names of the passport holder.
-
-```rb
-puts result.document.inference.prediction.given_names.value
-```
-
-## ID Number
-**id_number** ([StringField](#string-field)): The identification number of the passport document.
-
-```rb
-puts result.document.inference.prediction.id_number.value
-```
-
-## Issuance Date
-**issuance_date** ([DateField](#date-field)): The date when the passport was issued, ISO format: YYYY-MM-DD.
-
-```rb
-puts result.document.inference.prediction.issuance_date.value
-```
-
-## Issuance Place
-**issuance_place** ([StringField](#string-field)): The place where the passport was issued.
-
-```rb
-puts result.document.inference.prediction.issuance_place.value
-```
-
-## Legal Guardian
-**legal_guardian** ([StringField](#string-field)): The name of the legal guardian of the passport holder (if applicable).
-
-```rb
-puts result.document.inference.prediction.legal_guardian.value
-```
-
-## MRZ Line 1
-**mrz1** ([StringField](#string-field)): The first line of the machine-readable zone (MRZ) of the passport document.
-
-```rb
-puts result.document.inference.prediction.mrz1.value
-```
-
-## MRZ Line 2
-**mrz2** ([StringField](#string-field)): The second line of the machine-readable zone (MRZ) of the passport document.
-
-```rb
-puts result.document.inference.prediction.mrz2.value
-```
-
-## Name of Mother
-**name_of_mother** ([StringField](#string-field)): The name of the mother of the passport holder.
-
-```rb
-puts result.document.inference.prediction.name_of_mother.value
-```
-
-## Name of Spouse
-**name_of_spouse** ([StringField](#string-field)): The name of the spouse of the passport holder (if applicable).
-
-```rb
-puts result.document.inference.prediction.name_of_spouse.value
-```
-
-## Old Passport Date of Issue
-**old_passport_date_of_issue** ([DateField](#date-field)): The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
-
-```rb
-puts result.document.inference.prediction.old_passport_date_of_issue.value
-```
-
-## Old Passport Number
-**old_passport_number** ([StringField](#string-field)): The number of the old passport (if applicable).
-
-```rb
-puts result.document.inference.prediction.old_passport_number.value
-```
-
-## Old Passport Place of Issue
-**old_passport_place_of_issue** ([StringField](#string-field)): The place of issue of the old passport (if applicable).
-
-```rb
-puts result.document.inference.prediction.old_passport_place_of_issue.value
-```
-
-## Page Number
-**page_number** ([ClassificationField](#classification-field)): The page number of the passport document.
-
-#### Possible values include:
- - '1'
- - '2'
-
-```rb
-puts result.document.inference.prediction.page_number.value
-```
-
-## Surname
-**surname** ([StringField](#string-field)): The surname of the passport holder.
-
-```rb
-puts result.document.inference.prediction.surname.value
-```
-
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)