add OCR classes

Author: ianardee

src/main/java/com/mindee/v2/product/classification/ClassificationResult.java

@@ -26,7 +26,7 @@ public final class ClassificationResult {
   @Override
   public String toString() {
     StringJoiner joiner = new StringJoiner("\n");
-    joiner.add("Classification").add("==============");
+    joiner.add("Classification\n==============");
     joiner.add(classification.toString());
 
     return joiner.toString();

src/main/java/com/mindee/v2/product/crop/CropResult.java

@@ -27,8 +27,8 @@ public final class CropResult {
   @Override
   public String toString() {
     StringJoiner joiner = new StringJoiner("\n");
-    joiner.add("Crops").add("=====");
-    for (CropItem item : this.crops) {
+    joiner.add("Crops\n=====");
+    for (CropItem item : crops) {
       joiner.add(item.toString());
     }
     return joiner.toString();

src/main/java/com/mindee/v2/product/ocr/OcrInference.java

@@ -0,0 +1,9 @@
+package com.mindee.v2.product.ocr;
+
+import com.mindee.v2.parsing.BaseInference;
+
+/**
+ * The inference result for an OCR utility request.
+ */
+public class OcrInference extends BaseInference<OcrResult> {
+}

src/main/java/com/mindee/v2/product/ocr/OcrPage.java

@@ -0,0 +1,31 @@
+package com.mindee.v2.product.ocr;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.ArrayList;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * OCR result for a single page.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class OcrPage {
+  /**
+   * Full text content extracted from the document page.
+   */
+  @JsonProperty("content")
+  private String content;
+
+  /**
+   * List of words extracted from the document page.
+   */
+  @JsonProperty("words")
+  private ArrayList<OcrWord> words;
+}

src/main/java/com/mindee/v2/product/ocr/OcrResponse.java

@@ -0,0 +1,20 @@
+package com.mindee.v2.product.ocr;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.mindee.parsing.v2.CommonResponse;
+import lombok.Getter;
+
+/**
+ * Response for an OCR utility inference.
+ */
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class OcrResponse extends CommonResponse {
+
+  /**
+   * The inference result for an OCR utility request.
+   */
+  @JsonProperty("inference")
+  private OcrInference inference;
+}

src/main/java/com/mindee/v2/product/ocr/OcrResult.java

@@ -0,0 +1,36 @@
+package com.mindee.v2.product.ocr;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.ArrayList;
+import java.util.StringJoiner;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Result of the OCR utility inference.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public final class OcrResult {
+  /**
+   * List of OCR results for each page in the document.
+   */
+  @JsonProperty("pages")
+  private ArrayList<OcrPage> pages;
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add("Pages\n======");
+    for (OcrPage page : pages) {
+      joiner.add(page.toString());
+    }
+    return joiner.toString();
+  }
+}

src/main/java/com/mindee/v2/product/ocr/OcrWord.java

@@ -0,0 +1,31 @@
+package com.mindee.v2.product.ocr;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.mindee.geometry.Polygon;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * OCR result for a single word extracted from the document page.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class OcrWord {
+  /**
+   * Text content of the word.
+   */
+  @JsonProperty("content")
+  private String content;
+
+  /**
+   * Position information as a list of points in clockwise order.
+   */
+  @JsonProperty("polygon")
+  private Polygon polygon;
+}

src/test/java/com/mindee/v2/product/OcrTest.java

@@ -0,0 +1,62 @@
+package com.mindee.v2.product;
+
+import static com.mindee.TestingUtilities.getV2ResourcePath;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import com.mindee.input.LocalResponse;
+import com.mindee.v2.product.ocr.OcrPage;
+import com.mindee.v2.product.ocr.OcrResponse;
+import java.io.IOException;
+import java.util.ArrayList;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+@DisplayName("MindeeV2 - OCR Model Tests")
+public class OcrTest {
+  private OcrResponse loadResponse(String filePath) throws IOException {
+    LocalResponse localResponse = new LocalResponse(getV2ResourcePath(filePath));
+    return localResponse.deserializeResponse(OcrResponse.class);
+  }
+
+  @Nested
+  @DisplayName("Result with single value")
+  class SinglePredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      OcrResponse response = loadResponse("products/ocr/ocr_single.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<OcrPage> pages = response.getInference().getResult().getPages();
+      assertEquals(1, pages.size());
+      assertEquals(305, pages.get(0).getWords().size());
+      assertEquals("Shipper:", pages.get(0).getWords().get(0).getContent());
+    }
+  }
+
+  @Nested
+  @DisplayName("Result with multiple values")
+  class MultiPredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      OcrResponse response = loadResponse("products/ocr/ocr_multiple.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<OcrPage> pages = response.getInference().getResult().getPages();
+      assertEquals(3, pages.size());
+
+      OcrPage page1 = pages.get(0);
+      assertNotNull(page1.getContent());
+      assertEquals(295, page1.getWords().size());
+      assertEquals("FICTIOCORP", page1.getWords().get(0).getContent());
+
+      OcrPage page2 = pages.get(1);
+      assertNotNull(page2.getContent());
+      assertEquals(450, page2.getWords().size());
+      assertEquals("KEOLIO", page2.getWords().get(0).getContent());
+    }
+  }
+}