Share via

DocumentSelectionMark Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.6
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentSelectionMark

Implements

JsonSerializable<DocumentSelectionMark>

public final class DocumentSelectionMark
implements JsonSerializable<DocumentSelectionMark>

A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.

Method Summary

Modifier and Type Method and Description
static DocumentSelectionMark fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentSelectionMark fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getConfidence

public double getConfidence()

Get the confidence property: Confidence of correctly extracting the selection mark.

Returns:

the confidence 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.

getState

public DocumentSelectionMarkState getState()

Get the state property: State of the selection mark.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to