com.mindee.parsing.common.Document 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.common.ocr.Ocr;
import lombok.EqualsAndHashCode;
import lombok.Getter;

/**
 * Define the parsed document.
 */
@Getter
@EqualsAndHashCode
@JsonIgnoreProperties(ignoreUnknown = true)
public class Document {

  /**
   * Define the inference model of values.
   */
  @JsonProperty("inference")
  private DocT inference;
  /**
   * The original file name of the parsed document.
   */
  @JsonProperty("name")
  private String filename;
  /**
   * Document identifier, generated on each API call.
   */
  @JsonProperty("id")
  private String id;
  /**
   * Ocr result information.
   */
  @JsonProperty("ocr")
  private Ocr ocr;
  /**
   * Number of pages in the document.
   */
  @JsonProperty("n_pages")
  private int nPages;

  @Override
  public String toString() {
    return
      String.format("########%n")
      + String.format("Document%n")
      + String.format("########%n")
      + String.format(":Mindee ID: %s%n", id)
      + String.format(":Filename: %s%n", filename)
      + inference.toString();
  }
}