♻️ update raw text structure

Author: ianardee

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

@@ -35,6 +35,12 @@ public class Inference {
   @JsonProperty("file")
   private InferenceFile file;
 
+  /**
+   * Active options for the inference.
+   */
+  @JsonProperty("active_options")
+  private InferenceActiveOptions activeOptions;
+
   /**
    * Model result values.
    */
@@ -47,12 +53,12 @@ public String toString() {
     joiner
         .add("Inference")
         .add("#########")
-        .add("Model")
-        .add("=====")
-        .add(":ID: " + (model != null ? model.getId() : ""))
+        .add(model.toString())
         .add("")
         .add(file.toString())
         .add("")
+        .add(activeOptions.toString())
+        .add("")
         .add(result != null ? result.toString() : "");
     return joiner.toString().trim() + "\n";
   }

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

@@ -0,0 +1,65 @@
+package com.mindee.parsing.v2;
+
+import static com.mindee.parsing.SummaryHelper.formatForDisplay;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.StringJoiner;
+
+/**
+ * Option response for V2 API inference.
+ */
+public final class InferenceActiveOptions {
+
+  @JsonProperty("rag")
+  private boolean rag;
+
+  @JsonProperty("raw_text")
+  private boolean rawText;
+
+  @JsonProperty("polygon")
+  private boolean polygon;
+
+  @JsonProperty("confidence")
+  private boolean confidence;
+
+  /**
+   * Whether the RAG feature was activated.
+   */
+  public boolean getRag() {
+    return rag;
+  }
+
+  /**
+   * Whether the Raw Text feature was activated.
+   */
+  public boolean getRawText() {
+    return rawText;
+  }
+
+  /**
+   * Whether the polygon feature was activated.
+   */
+  public boolean getPolygon() {
+    return polygon;
+  }
+
+  /**
+   * Whether the confidence feature was activated.
+   */
+  public boolean getConfidence() {
+    return confidence;
+  }
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    return joiner
+        .add("Active Options")
+        .add("==============")
+        .add(":Raw Text: " + formatForDisplay(rawText, 5))
+        .add(":Polygon: " + formatForDisplay(polygon, 5))
+        .add(":Confidence: " + formatForDisplay(confidence, 5))
+        .add(":RAG: " + formatForDisplay(rag, 5))
+        .toString();
+  }
+}

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

@@ -2,6 +2,7 @@
 
 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;
@@ -22,4 +23,13 @@ public class InferenceModel {
    */
   @JsonProperty("id")
   private String id;
+
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    return joiner
+        .add("Model")
+        .add("=====")
+        .add(":ID: " + id)
+        .toString();
+  }
 }

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

@@ -28,20 +28,16 @@ public final class InferenceResult {
   /**
    * Options.
    */
-  @JsonProperty("options")
-  private InferenceResultOptions options;
+  @JsonProperty("raw_text")
+  private RawText rawText;
 
   @Override
   public String toString() {
     StringJoiner joiner = new StringJoiner("\n");
     joiner.add("Fields")
           .add("======");
     joiner.add(fields.toString());
-    if (this.getOptions() != null) {
-      joiner.add("Options")
-          .add("=======")
-          .add(this.getOptions().toString());
-    }
+
     return joiner.toString();
   }
 }

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

@@ -2,6 +2,8 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import java.util.StringJoiner;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -17,12 +19,19 @@ public class RawText {
   /*
    * Page Number the text was found on.
    */
-  @JsonProperty("page")
-  private Integer page;
+  @JsonProperty("pages")
+  private List<RawTextPage> pages;
 
-  /*
-   * Content of the raw text.
-   */
-  @JsonProperty("content")
-  private String content;
+  @Override
+  public String toString() {
+    if (pages == null || pages.isEmpty()) {
+      return "";
+    }
+    StringJoiner joiner = new StringJoiner("\n\n");
+    for (RawTextPage page : pages) {
+      joiner.add(page.toString());
+    }
+    return joiner.toString();
+
+  }
 }

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

@@ -0,0 +1,33 @@
+package com.mindee.parsing.v2;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Raw text extracted from the page.
+ */
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class RawTextPage {
+  /**
+   * Page content as a single string.
+   */
+  @JsonProperty("content")
+  private String content;
+
+  /**
+   * Page contents as a string.
+   */
+  @Override
+  public String toString() {
+    if (content == null) {
+      return "";
+    }
+    return content;
+  }
+}

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

@@ -3,6 +3,7 @@
 import com.mindee.http.MindeeHttpExceptionV2;
 import com.mindee.input.LocalInputSource;
 import com.mindee.input.URLInputSource;
+import com.mindee.parsing.v2.InferenceActiveOptions;
 import com.mindee.parsing.v2.InferenceResponse;
 import java.io.File;
 import java.io.IOException;
@@ -55,7 +56,13 @@ void parseFile_emptyMultiPage_mustSucceed() throws IOException, InterruptedExcep
     assertEquals(modelId, response.getInference().getModel().getId());
 
     assertNotNull(response.getInference().getResult());
-    assertNull(response.getInference().getResult().getOptions());
+
+    InferenceActiveOptions activeOptions = response.getInference().getActiveOptions();
+    assertNotNull(activeOptions);
+    assertFalse(activeOptions.getRag());
+    assertFalse(activeOptions.getRawText());
+    assertFalse(activeOptions.getPolygon());
+    assertFalse(activeOptions.getConfidence());
   }
 
   @Test

src/test/java/com/mindee/MindeeClientV2IT.java

@@ -99,22 +99,22 @@ class CompletePrediction {
     @DisplayName("every exposed property must be valid and consistent")
     void asyncPredict_whenComplete_mustExposeAllProperties() throws IOException {
       InferenceResponse response = loadFromResource("v2/products/financial_document/complete.json");
-      Inference inf = response.getInference();
-      assertNotNull(inf, "Inference must not be null");
-      assertEquals("12345678-1234-1234-1234-123456789abc", inf.getId(), "Inference ID mismatch");
+      Inference inference = response.getInference();
+      assertNotNull(inference, "Inference must not be null");
+      assertEquals("12345678-1234-1234-1234-123456789abc", inference.getId(), "Inference ID mismatch");
 
-      InferenceModel model = inf.getModel();
+      InferenceModel model = inference.getModel();
       assertNotNull(model, "Model must not be null");
       assertEquals("12345678-1234-1234-1234-123456789abc", model.getId(), "Model ID mismatch");
 
-      InferenceFile file = inf.getFile();
+      InferenceFile file = inference.getFile();
       assertNotNull(file, "File must not be null");
       assertEquals("complete.jpg", file.getName(), "File name mismatch");
       assertEquals(1, file.getPageCount(), "Page count mismatch");
       assertEquals("image/jpeg", file.getMimeType(), "MIME type mismatch");
       assertNull(file.getAlias(), "File alias must be null for this payload");
 
-      InferenceFields fields = inf.getResult().getFields();
+      InferenceFields fields = inference.getResult().getFields();
       assertEquals(21, fields.size(), "Expected 21 fields in the payload");
 
       SimpleField date = fields.get("date").getSimpleField();
@@ -146,7 +146,8 @@ void asyncPredict_whenComplete_mustExposeAllProperties() throws IOException {
       SimpleField city = customerAddr.getFields().get("city").getSimpleField();
       assertEquals("New York", city.getValue(), "City mismatch");
 
-      assertNull(inf.getResult().getOptions(), "Options must be null");
+      InferenceActiveOptions activeOptions = inference.getActiveOptions();
+      assertNotNull(activeOptions);
     }
   }
 
@@ -451,17 +452,20 @@ class RawTexts {
     @DisplayName("raw texts option must be parsed and exposed")
     void rawTexts_mustBeAccessible() throws IOException {
       InferenceResponse resp = loadFromResource("v2/inference/raw_texts.json");
-      Inference inf = resp.getInference();
-      assertNotNull(inf);
+      Inference inference = resp.getInference();
+      assertNotNull(inference);
 
-      InferenceResultOptions opts = inf.getResult().getOptions();
-      assertNotNull(opts, "Options should not be null");
+      InferenceActiveOptions activeOptions = inference.getActiveOptions();
+      assertNotNull(activeOptions);
+      assertFalse(activeOptions.getRag());
+      assertTrue(activeOptions.getRawText());
+      assertFalse(activeOptions.getPolygon());
+      assertFalse(activeOptions.getConfidence());
 
-      List<RawText> rawTexts = opts.getRawTexts();
-      assertEquals(2, rawTexts.size());
+      RawText rawText = inference.getResult().getRawText();
+      assertEquals(2, rawText.getPages().size());
 
-      RawText first = rawTexts.get(0);
-      assertEquals(0, first.getPage());
+      RawTextPage first = rawText.getPages().get(0);
       assertEquals("This is the raw text of the first page...", first.getContent());
     }
   }