Package com.azure.ai.formrecognizer.models

Class FormReadingOrder

java.lang.Object

com.azure.core.util.ExpandableStringEnum<FormReadingOrder>

com.azure.ai.formrecognizer.models.FormReadingOrder

public final class FormReadingOrder
extends com.azure.core.util.ExpandableStringEnum<FormReadingOrder>

Defines values for the order in which recognized text lines are returned.

Field Summary

Fields

Modifier and Type	Field	Description
static final FormReadingOrder	BASIC	Static value BASIC for FormReadingOrder.
static final FormReadingOrder	NATURAL	Static value NATURAL for FormReadingOrder.

Constructor Summary

Constructors

Constructor	Description
FormReadingOrder()

Method Summary

Modifier and Type	Method	Description
static FormReadingOrder	fromString(String value)	Parses a serialized value to a FormReadingOrder instance.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BASIC

public static final FormReadingOrder BASIC

Static value BASIC for FormReadingOrder. Set it to basic for the lines to be sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority.

NATURAL

public static final FormReadingOrder NATURAL

Static value NATURAL for FormReadingOrder. Set it to "natural" value for the algorithm to use positional information to keep nearby lines together.

Constructor Details

FormReadingOrder

public FormReadingOrder()

Method Details

fromString

public static FormReadingOrder fromString(String value)

Parses a serialized value to a FormReadingOrder instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed FormReadingOrder object, or null if unable to parse.