The Ruby OCR SDK supports the Carte Vitale API.
Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
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
######## 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
These fields are generic and used in several products.
Each prediction object contains a set of fields that inherit from the generic
Field object will have the following attributes:
- value (
Boolean): corresponds to the field value. Can be
nilif no value was extracted.
- confidence (Float, nil): the confidence score of the field prediction.
- bounding_box (
nil): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
- polygon (
nil): contains the relative vertices coordinates (
Point) of a polygon containing the field in the image.
- page_id (
nil): the ID of the page, is
nilwhen 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.
Aside from the basic
Field attributes, the date field
DateField also implements the following:
- date_object (
The text field
StringField only has one constraint: it's value is a
The following fields are extracted for Carte Vitale V1:
given_names (Array<StringField>): The given name(s) of the card holder.
for given_names_elem in result.document.inference.prediction.given_names do puts given_names_elem.value end
issuance_date (DateField): The date the card was issued.
social_security (StringField): The Social Security Number (Numéro de Sécurité Sociale) of the card holder
surname (StringField): The surname of the card holder.
Updated 11 days ago