update samples, switch syntax for indian passport

Author: sebastianMindee

docs/business_card_v1.md

@@ -6,7 +6,7 @@ parentDoc: 631a062c3718850f3519b793
 ---
 The Java OCR SDK supports the [Business Card API](https://platform.mindee.com/mindee/business_card).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/business_card/default_sample.jpg) can be used for testing purposes.
+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
@@ -54,6 +54,36 @@ public class SimpleMindeeClient {
 }
 
 ```
+
+**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.

docs/code_samples/ind_passport_v1_async.txt

@@ -1,7 +1,7 @@
 import com.mindee.MindeeClient;
 import com.mindee.input.LocalInputSource;
 import com.mindee.parsing.common.AsyncPredictResponse;
-import com.mindee.product.ind.passport.PassportV1;
+import com.mindee.product.ind.indianpassport.IndianPassportV1;
 import java.io.File;
 import java.io.IOException;
 
@@ -18,8 +18,8 @@ public class SimpleMindeeClient {
     LocalInputSource inputSource = new LocalInputSource(new File(filePath));
 
     // Parse the file asynchronously
-    AsyncPredictResponse<PassportV1> response = mindeeClient.enqueueAndParse(
-        PassportV1.class,
+    AsyncPredictResponse<IndianPassportV1> response = mindeeClient.enqueueAndParse(
+        IndianPassportV1.class,
         inputSource
     );
 

docs/delivery_notes_v1.md

@@ -6,7 +6,7 @@ parentDoc: 631a062c3718850f3519b793
 ---
 The Java OCR SDK supports the [Delivery note API](https://platform.mindee.com/mindee/delivery_notes).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/delivery_notes/default_sample.jpg) can be used for testing purposes.
+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
@@ -54,6 +54,31 @@ public class SimpleMindeeClient {
 }
 
 ```
+
+**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.

docs/ind_passport_v1.md

@@ -1,20 +1,20 @@
 ---
-title: IND Passport OCR Java
+title: IND Indian Passport OCR Java
 category: 622b805aaec68102ea7fcbc2
-slug: java-ind-passport-ocr
+slug: java-ind-indian-passport-ocr
 parentDoc: 631a062c3718850f3519b793
 ---
-The Java OCR SDK supports the [Passport API](https://platform.mindee.com/mindee/ind_passport).
+The Java OCR SDK supports the [Indian Passport API](https://platform.mindee.com/mindee/ind_passport).
 
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg) can be used for testing purposes.
-![Passport sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg?raw=true)
+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 OCR SDK.
+![Indian Passport sample](https://github.com/mindee/client-lib-test-data/blob/main/products/ind_passport/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```java
 import com.mindee.MindeeClient;
 import com.mindee.input.LocalInputSource;
 import com.mindee.parsing.common.AsyncPredictResponse;
-import com.mindee.product.ind.passport.PassportV1;
+import com.mindee.product.ind.indianpassport.IndianPassportV1;
 import java.io.File;
 import java.io.IOException;
 
@@ -31,8 +31,8 @@ public class SimpleMindeeClient {
     LocalInputSource inputSource = new LocalInputSource(new File(filePath));
 
     // Parse the file asynchronously
-    AsyncPredictResponse<PassportV1> response = mindeeClient.enqueueAndParse(
-        PassportV1.class,
+    AsyncPredictResponse<IndianPassportV1> response = mindeeClient.enqueueAndParse(
+        IndianPassportV1.class,
         inputSource
     );
 
@@ -54,6 +54,47 @@ public class SimpleMindeeClient {
 }
 
 ```
+
+**Output (RST):**
+```rst
+########
+Document
+########
+:Mindee ID: cf88fd43-eaa1-497a-ba29-a9569a4edaa7
+:Filename: default_sample.jpg
+
+Inference
+#########
+:Product: mindee/ind_passport v1.0
+: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:
+:Address Line 1:
+:Address Line 2:
+:Address Line 3:
+:Old Passport Place of Issue:
+:File Number:
+```
+
 # Field Types
 ## Standard Fields
 These fields are generic and used in several products.
@@ -91,7 +132,7 @@ The date field `DateField` extends `BaseField`, but also implements:
 * **value** (`LocalDate`): an accessible representation of the value as a Java object. Can be `null`.
 
 # Attributes
-The following fields are extracted for Passport V1:
+The following fields are extracted for Indian Passport V1:
 
 ## Address Line 1
 **address1**: The first line of the address of the passport holder.

docs/resume_v1.md

@@ -60,13 +60,13 @@ public class SimpleMindeeClient {
 ########
 Document
 ########
-:Mindee ID: bc80bae0-af75-4464-95a9-2419403c75bf
+:Mindee ID: 9daa3085-152c-454e-9245-636f13fc9dc3
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/resume v1.0
-:Rotation applied: No
+:Product: mindee/resume v1.1
+:Rotation applied: Yes
 
 Prediction
 ==========
@@ -76,8 +76,8 @@ Prediction
 :Surnames: Morgan
 :Nationality:
 :Email Address: christoper.m@gmail.com
-:Phone Number: +44 (0) 20 7666 8555
-:Address: 177 Great Portland Street, London W5W 6PQ
+:Phone Number: +44 (0)20 7666 8555
+:Address: 177 Great Portland Street, London, W5W 6PQ
 :Social Networks:
   +----------------------+----------------------------------------------------+
   | Name                 | URL                                                |
@@ -94,38 +94,37 @@ Prediction
   +----------+----------------------+
   | ZHO      | Beginner             |
   +----------+----------------------+
-  | DEU      | Intermediate         |
+  | DEU      | Beginner             |
   +----------+----------------------+
 :Hard Skills: HTML5
               PHP OOP
               JavaScript
               CSS
               MySQL
+              SQL
 :Soft Skills: Project management
+              Creative design
               Strong decision maker
               Innovative
               Complex problem solver
-              Creative design
               Service-focused
 :Education:
   +-----------------+---------------------------+-----------+----------+---------------------------+-------------+------------+
   | Domain          | Degree                    | End Month | End Year | School                    | Start Month | Start Year |
   +=================+===========================+===========+==========+===========================+=============+============+
-  | Computer Inf... | Bachelor                  |           |          | Columbia University, NY   |             | 2014       |
+  | Computer Inf... | Bachelor                  |           | 2014     | Columbia University, NY   |             |            |
   +-----------------+---------------------------+-----------+----------+---------------------------+-------------+------------+
 :Professional Experiences:
-  +-----------------+------------+---------------------------+-----------+----------+----------------------+-------------+------------+
-  | Contract Type   | Department | Employer                  | End Month | End Year | Role                 | Start Month | Start Year |
-  +=================+============+===========================+===========+==========+======================+=============+============+
-  | Full-Time       |            | Luna Web Design, New York | 05        | 2019     | Web Developer        | 09          | 2015       |
-  +-----------------+------------+---------------------------+-----------+----------+----------------------+-------------+------------+
+  +-----------------+------------+--------------------------------------+---------------------------+-----------+----------+----------------------+-------------+------------+
+  | Contract Type   | Department | Description                          | Employer                  | End Month | End Year | Role                 | Start Month | Start Year |
+  +=================+============+======================================+===========================+===========+==========+======================+=============+============+
+  |                 |            | Cooperate with designers to creat... | Luna Web Design, New York | 05        | 2019     | Web Developer        | 09          | 2015       |
+  +-----------------+------------+--------------------------------------+---------------------------+-----------+----------+----------------------+-------------+------------+
 :Certificates:
   +------------+--------------------------------+---------------------------+------+
   | Grade      | Name                           | Provider                  | Year |
   +============+================================+===========================+======+
-  |            | PHP Framework (certificate)... |                           | 2014 |
-  +------------+--------------------------------+---------------------------+------+
-  |            | Programming Languages: Java... |                           |      |
+  |            | PHP Framework (certificate)... |                           |      |
   +------------+--------------------------------+---------------------------+------+
 ```
 

…dee/product/ind/passport/PassportV1.java …ind/indianpassport/IndianPassportV1.javasrc/main/java/com/mindee/product/ind/passport/PassportV1.java renamed to src/main/java/com/mindee/product/ind/indianpassport/IndianPassportV1.java src/main/java/com/mindee/product/ind/passport/PassportV1.java renamed to src/main/java/com/mindee/product/ind/indianpassport/IndianPassportV1.java

@@ -1,16 +1,16 @@
-package com.mindee.product.ind.passport;
+package com.mindee.product.ind.indianpassport;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.mindee.http.EndpointInfo;
 import com.mindee.parsing.common.Inference;
 import lombok.Getter;
 
 /**
- * Passport API version 1 inference prediction.
+ * Indian Passport API version 1 inference prediction.
  */
 @Getter
 @JsonIgnoreProperties(ignoreUnknown = true)
 @EndpointInfo(endpointName = "ind_passport", version = "1")
-public class PassportV1
-    extends Inference<PassportV1Document, PassportV1Document> {
+public class IndianPassportV1
+    extends Inference<IndianPassportV1Document, IndianPassportV1Document> {
 }

…uct/ind/passport/PassportV1Document.java …anpassport/IndianPassportV1Document.javasrc/main/java/com/mindee/product/ind/passport/PassportV1Document.java renamed to src/main/java/com/mindee/product/ind/indianpassport/IndianPassportV1Document.java src/main/java/com/mindee/product/ind/passport/PassportV1Document.java renamed to src/main/java/com/mindee/product/ind/indianpassport/IndianPassportV1Document.java

@@ -1,4 +1,4 @@
-package com.mindee.product.ind.passport;
+package com.mindee.product.ind.indianpassport;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -11,12 +11,12 @@
 import lombok.Getter;
 
 /**
- * Passport API version 1.0 document data.
+ * Indian Passport API version 1.0 document data.
  */
 @Getter
 @EqualsAndHashCode(callSuper = false)
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class PassportV1Document extends Prediction {
+public class IndianPassportV1Document extends Prediction {
 
   /**
    * The first line of the address of the passport holder.

…product/ind/passport/PassportV1Test.java …indianpassport/IndianPassportV1Test.javasrc/test/java/com/mindee/product/ind/passport/PassportV1Test.java renamed to src/test/java/com/mindee/product/ind/indianpassport/IndianPassportV1Test.java src/test/java/com/mindee/product/ind/passport/PassportV1Test.java renamed to src/test/java/com/mindee/product/ind/indianpassport/IndianPassportV1Test.java

@@ -1,4 +1,4 @@
-package com.mindee.product.ind.passport;
+package com.mindee.product.ind.indianpassport;
 
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -12,17 +12,17 @@
 import java.io.IOException;
 
 /**
- * Unit tests for PassportV1.
+ * Unit tests for IndianPassportV1.
  */
-public class PassportV1Test {
+public class IndianPassportV1Test {
 
-  protected PredictResponse<PassportV1> getPrediction(String name) throws IOException {
+  protected PredictResponse<IndianPassportV1> getPrediction(String name) throws IOException {
     ObjectMapper objectMapper = new ObjectMapper();
     objectMapper.findAndRegisterModules();
 
     JavaType type = objectMapper.getTypeFactory().constructParametricType(
       PredictResponse.class,
-      PassportV1.class
+      IndianPassportV1.class
     );
     return objectMapper.readValue(
       new File("src/test/resources/products/ind_passport/response_v1/" + name + ".json"),
@@ -32,8 +32,8 @@ protected PredictResponse<PassportV1> getPrediction(String name) throws IOExcept
 
   @Test
   void whenEmptyDeserialized_mustHaveValidProperties() throws IOException {
-    PredictResponse<PassportV1> response = getPrediction("empty");
-    PassportV1Document docPrediction = response.getDocument().getInference().getPrediction();
+    PredictResponse<IndianPassportV1> response = getPrediction("empty");
+    IndianPassportV1Document docPrediction = response.getDocument().getInference().getPrediction();
     Assertions.assertInstanceOf(ClassificationField.class, docPrediction.getPageNumber());
     Assertions.assertNull(docPrediction.getCountry().getValue());
     Assertions.assertNull(docPrediction.getIdNumber().getValue());
@@ -61,8 +61,8 @@ void whenEmptyDeserialized_mustHaveValidProperties() throws IOException {
 
   @Test
   void whenCompleteDeserialized_mustHaveValidDocumentSummary() throws IOException {
-    PredictResponse<PassportV1> response = getPrediction("complete");
-    Document<PassportV1> doc = response.getDocument();
+    PredictResponse<IndianPassportV1> response = getPrediction("complete");
+    Document<IndianPassportV1> doc = response.getDocument();
     ProductTestHelper.assertStringEqualsFile(
         doc.toString(),
         "src/test/resources/products/ind_passport/response_v1/summary_full.rst"