add classification classes

Author: ianardee

src/main/java/com/mindee/parsing/v2/CommonResponse.java

@@ -16,8 +16,4 @@ public abstract class CommonResponse {
    * This is not formatted in any way by the library and may contain newline and tab characters.
    */
   private String rawResponse;
-
-  public void setRawResponse(String contents) {
-    rawResponse = contents;
-  }
 }

src/main/java/com/mindee/parsing/v2/Inference.java

@@ -15,23 +15,17 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 @AllArgsConstructor
 @NoArgsConstructor
-public class Inference extends BaseInference {
+public class Inference extends BaseInference<InferenceResult> {
   /**
    * Active options for the inference.
    */
   @JsonProperty("active_options")
   private InferenceActiveOptions activeOptions;
 
-  /**
-   * Model result values.
-   */
-  @JsonProperty("result")
-  private InferenceResult result;
-
   @Override
   public String toString() {
     StringJoiner joiner = new StringJoiner("\n");
-    joiner.add(activeOptions.toString()).add("").add(result != null ? result.toString() : "");
-    return super.toString() + "\n" + joiner.toString().trim() + "\n";
+    joiner.add(toStringBase()).add(activeOptions.toString()).add("").add(result.toString());
+    return joiner.toString().trim() + "\n";
   }
 }

src/main/java/com/mindee/v2/parsing/BaseInference.java

@@ -17,7 +17,7 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 @AllArgsConstructor
 @NoArgsConstructor
-public abstract class BaseInference {
+public abstract class BaseInference<TResult> {
   /**
    * Inference ID.
    */
@@ -42,8 +42,13 @@ public abstract class BaseInference {
   @JsonProperty("file")
   protected InferenceFile file;
 
-  @Override
-  public String toString() {
+  /**
+   * Result of the inference.
+   */
+  @JsonProperty("result")
+  protected TResult result;
+
+  protected String toStringBase() {
     StringJoiner joiner = new StringJoiner("\n");
     joiner
       .add("Inference")
@@ -55,4 +60,11 @@ public String toString() {
       .add(file.toString());
     return joiner.toString().trim() + "\n";
   }
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add(toStringBase()).add("").add(result.toString());
+    return joiner.toString().trim() + "\n";
+  }
 }

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

@@ -0,0 +1,23 @@
+package com.mindee.v2.product.classification;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Getter;
+
+/**
+ * Classification of the document type from the source file.
+ */
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ClassificationClassifier {
+  /**
+   * The document type, as identified on given classification values.
+   */
+  @JsonProperty("document_type")
+  private String documentType;
+
+  @Override
+  public String toString() {
+    return "Document Type: " + documentType;
+  }
+}

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

@@ -0,0 +1,9 @@
+package com.mindee.v2.product.classification;
+
+import com.mindee.v2.parsing.BaseInference;
+
+/**
+ * The inference result for a classification utility request.
+ */
+public class ClassificationInference extends BaseInference<ClassificationResult> {
+}

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

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

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

@@ -0,0 +1,34 @@
+package com.mindee.v2.product.classification;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.StringJoiner;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Result of the document classifier inference.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public final class ClassificationResult {
+  /**
+   * Classification of the document type from the source file.
+   */
+  @JsonProperty("classification")
+  private ClassificationClassifier classification;
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add("Classification").add("==============");
+    joiner.add(classification.toString());
+
+    return joiner.toString();
+  }
+}

src/test/java/com/mindee/TestingUtilities.java

@@ -39,6 +39,10 @@ public static void assertStringEqualsFile(String expected, String filePath) thro
     Assertions.assertEquals(expectedSummary, actualSummary);
   }
 
+  public static void assertStringEqualsFile(String expected, Path filePath) throws IOException {
+    assertStringEqualsFile(expected, filePath.toString());
+  }
+
   /**
    * Retrieves the version from an RST prediction output.
    *

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

@@ -0,0 +1,37 @@
+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.classification.ClassificationResponse;
+import java.io.IOException;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+@DisplayName("MindeeV2 - Classification Model Tests")
+public class ClassificationTest {
+  private ClassificationResponse loadResponse(String filePath) throws IOException {
+    LocalResponse localResponse = new LocalResponse(getV2ResourcePath(filePath));
+    return localResponse.deserializeResponse(ClassificationResponse.class);
+  }
+
+  @Nested
+  @DisplayName("Classification with single value")
+  class SinglePredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      ClassificationResponse response = loadResponse(
+        "products/classification/classification_single.json"
+      );
+      assertNotNull(response.getInference());
+      assertEquals(
+        "invoice",
+        response.getInference().getResult().getClassification().getDocumentType()
+      );
+    }
+  }
+}