Package com.azure.ai.documentintelligence.models

Class DocumentCaption

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentCaption
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentCaption>
public final class DocumentCaption extends Object implements com.azure.json.JsonSerializable<DocumentCaption>
A caption object describing a table or figure.

  • Method Details

    • getContent

      public String getContent()
      Get the content property: Content of the caption.
      Returns:
      the content value.

    • getBoundingRegions

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

    • getSpans

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

    • getElements

      public List<String> getElements()
      Get the elements property: Child elements of the caption.
      Returns:
      the elements value.

    • toJson

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

    • fromJson

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