Package com.azure.ai.documentintelligence.models

Class DocumentSelectionMark

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentSelectionMark
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentSelectionMark>
public final class DocumentSelectionMark extends Object implements com.azure.json.JsonSerializable<DocumentSelectionMark>
A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentSelectionMark
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentSelectionMark from the JsonReader.
    double
    getConfidence()
    Get the confidence property: Confidence of correctly extracting the selection mark.
    List<Double>
    getPolygon()
    Get the polygon property: Bounding polygon of the selection mark, with coordinates specified relative to the top-left of the page.
    DocumentSpan
    getSpan()
    Get the span property: Location of the selection mark in the reading order concatenated content.
    DocumentSelectionMarkState
    getState()
    Get the state property: State of the selection mark.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getState

      public DocumentSelectionMarkState getState()
      Get the state property: State of the selection mark.
      Returns:
      the state value.

    • getPolygon

      public List<Double> getPolygon()
      Get the polygon property: Bounding polygon of the selection mark, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.
      Returns:
      the polygon value.

    • getSpan

      public DocumentSpan getSpan()
      Get the span property: Location of the selection mark in the reading order concatenated content.
      Returns:
      the span value.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly extracting the selection mark.
      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<DocumentSelectionMark>
      Throws:
      IOException

    • fromJson

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