Package com.azure.ai.documentintelligence.models

Class DocumentFigure

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentFigure
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentFigure>
public final class DocumentFigure extends Object implements com.azure.json.JsonSerializable<DocumentFigure>
An object representing a figure in the document.

  • Method Details

    • getBoundingRegions

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

    • getSpans

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

    • getElements

      public List<String> getElements()
      Get the elements property: Child elements of the figure, excluding any caption or footnotes.
      Returns:
      the elements value.

    • getCaption

      public DocumentCaption getCaption()
      Get the caption property: Caption associated with the figure.
      Returns:
      the caption value.

    • getFootnotes

      public List<DocumentFootnote> getFootnotes()
      Get the footnotes property: List of footnotes associated with the figure.
      Returns:
      the footnotes value.

    • getId

      public String getId()
      Get the id property: Figure ID.
      Returns:
      the id value.

    • toJson

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

    • fromJson

      public static DocumentFigure fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentFigure from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentFigure 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 DocumentFigure.