Package com.azure.ai.documentintelligence.models

Class Document

java.lang.Object
com.azure.ai.documentintelligence.models.Document
All Implemented Interfaces:
com.azure.json.JsonSerializable<Document>
public final class Document extends Object implements com.azure.json.JsonSerializable<Document>
An object describing the location and semantic content of a document.

  • Method Details

    • getDocType

      public String getDocType()
      Get the docType property: Document type.
      Returns:
      the docType value.

    • getBoundingRegions

      public List<BoundingRegion> getBoundingRegions()
      Get the boundingRegions property: Bounding regions covering the document.
      Returns:
      the boundingRegions value.

    • getSpans

      public List<DocumentSpan> getSpans()
      Get the spans property: Location of the document in the reading order concatenated content.
      Returns:
      the spans value.

    • getFields

      public Map<String,DocumentField> getFields()
      Get the fields property: Dictionary of named field values.
      Returns:
      the fields value.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly extracting the document.
      Returns:
      the confidence value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<Document>
      Throws:
      IOException

    • fromJson

      public static Document fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of Document from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of Document if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the Document.