FormReadingOrder Class

Package:

com.azure.ai.formrecognizer.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.7

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.formrecognizer.models.FormReadingOrder

public final class FormReadingOrder
extends ExpandableStringEnum<FormReadingOrder>

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

Field Summary

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

Constructor Summary

Constructor	Description
FormReadingOrder()	Deprecated Use the fromString(String value) factory method. Creates a FormReadingOrder object.

Method Summary

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

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals hashCode toString

Methods inherited from 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

@Deprecated
public FormReadingOrder()

Deprecated

Use the fromString(String value) factory method.

Creates a FormReadingOrder object.

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.