com.mindee.parsing.common.Inference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mindee-api-java Show documentation

Java Library to call Mindee's Off-The-Shelf and Custom APIs

There is a newer version: 4.21.0

package com.mindee.parsing.common;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.mindee.parsing.SummaryHelper;
import java.util.stream.Collectors;
import lombok.Getter;

/**
 * Common inference data.
 *
 * @param      Page prediction (can be the same as TDocumentPrediction).
 * @param  Document prediction (can be the same as TPagePrediction).
 */
@Getter
@JsonIgnoreProperties(ignoreUnknown = true)
public abstract class Inference {

  /**
   * Whether a rotation was applied to parse the document.
   */
  @JsonProperty("is_rotation_applied")
  private boolean isRotationApplied;
  /**
   * Type of product.
   */
  @JsonProperty("product")
  private Product product;
  /**
   * The prediction on each pages of the document.
   */
  @JsonProperty("pages")
  protected Pages pages;
  /**
   * The prediction on the document level.
   */
  @JsonProperty("prediction")
  private TDocumentPrediction prediction;
  /**
   * Optional information.
   */
  @JsonProperty("extras")
  private InferenceExtras extras;

  @Override
  public String toString() {
    String summary =
        String.format("%nInference%n")
        + String.format("#########%n")
        + String.format(":Product: %s v%s%n", getProduct().getName(), getProduct().getVersion())
        + String.format(":Rotation applied: %s%n", isRotationApplied() ? "Yes" : "No")
        + String.format("%n")
        + String.format("Prediction%n")
        + String.format("==========%n")
        + prediction.toString();
    if (pages.hasPrediction()) {
      summary += String.format("%nPage Predictions%n")
        + String.format("================%n%n")
        + pages.toString();
    }
    summary += String.format("%n");
    return SummaryHelper.cleanSummary(summary);
  }

  public InferenceExtras getExtras() {
    if (this.pages != null && !this.pages.isEmpty()
        && (this.extras == null || this.extras.getFullTextOcr() == null)
    ) {
      if (this.extras == null) {
        this.extras = new InferenceExtras();
      }
      if (this.pages.get(0).getExtras() != null
          && this.pages.get(0).getExtras().getFullTextOcr() != null
      ) {
        this.extras.setFullTextOcr(String.join("\n",
            this.pages.stream().map(page -> page.getExtras().getFullTextOcr().getContent()).collect(
                Collectors.joining("\n"))));
      }
    }
    return this.extras;
  }
}