Package com.azure.ai.formrecognizer.models

Class RecognizedForm

java.lang.Object

com.azure.ai.formrecognizer.models.RecognizedForm

public final class RecognizedForm
extends Object

Represents a form that has been recognized by a trained or prebuilt model based on the provided input document.

Constructor Summary

Constructors

Constructor	Description
RecognizedForm(Map<String,FormField> fields, String formType, FormPageRange pageRange, List<FormPage> pages)	Constructs a RecognizedForm object.

Method Summary

Modifier and Type	Method	Description
Map<String,FormField>	getFields()	A map of the fields recognized from the input document.
String	getFormType()	Get the recognized form type.
Float	getFormTypeConfidence()	Get the confidence of the form type identified by the model.
String	getModelId()	Get the identifier of the model that was used for recognition, if not using a prebuilt model.
FormPageRange	getPageRange()	Get the first and last page number where the document is found.
List<FormPage>	getPages()	Get the list of extracted pages.

Methods inherited from class java.lang.Object

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

Constructor Details

RecognizedForm

public RecognizedForm(Map<String,FormField> fields,
 String formType,
 FormPageRange pageRange,
 List<FormPage> pages)

Constructs a RecognizedForm object.

Parameters:

fields - Dictionary of named field values.

formType - Form type.

pageRange - First and last page number where the document is found.

pages - List of extracted pages from the form.

Method Details

getFields

public Map<String,FormField> getFields()

A map of the fields recognized from the input document. For models trained with labels, this is the training-time label of the field. For models trained with forms only, a unique name is generated for each field.

Returns:

the unmodifiable map of recognized fields.

getFormType

public String getFormType()

Get the recognized form type.

Returns:

the formType value.

getPageRange

public FormPageRange getPageRange()

Get the first and last page number where the document is found.

Returns:

the pageRange value.

getPages

public List<FormPage> getPages()

Get the list of extracted pages.

Returns:

the unmodifiable list of recognized pages.

getFormTypeConfidence

public Float getFormTypeConfidence()

Get the confidence of the form type identified by the model.

Returns:

the formTypeConfidence value.

getModelId

public String getModelId()

Get the identifier of the model that was used for recognition, if not using a prebuilt model.

Returns:

the modelId value.