Class RecognizedForm

Represents a form that has been recognized by a trained or prebuilt model. The Fields property contains the form fields that were extracted from the form. Tables, text lines/words, and selection marks are extracted per page and found in the Pages property.

Inheritance

System.Object

RecognizedForm

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.FormRecognizer.dll

Syntax

public class RecognizedForm

Properties

Fields

A dictionary of the fields recognized from the input document. The key is the Name of the field. 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.

Declaration

public System.Collections.Generic.IReadOnlyDictionary<string,Azure.AI.FormRecognizer.Models.FormField> Fields { get; }

Property Value

System.Collections.Generic.IReadOnlyDictionary<System.String,FormField>

FormType

The type of form the model identified the submitted form to be.

Declaration

public string FormType { get; }

Property Value

System.String

FormTypeConfidence

Confidence on the type of form the model identified the submitted form to be. Value is 1.0 when recognition is done against a single labeled model. If recognition is based on a composed model, value is between [0.0, 1.0].

Declaration

public Nullable<float> FormTypeConfidence { get; }

Property Value

System.Nullable<System.Single>

Remarks

This property only has value for V2_1 and up.

ModelId

Model identifier of model used to analyze form if not using a prebuilt model.

Declaration

public string ModelId { get; }

Property Value

System.String

Remarks

This property only has value for V2_1 and up.

PageRange

The range of pages this form spans.

Declaration

public Azure.AI.FormRecognizer.Models.FormPageRange PageRange { get; }

Property Value

FormPageRange

Pages

A list of pages describing the recognized form elements present in the input document.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormPage> Pages { get; }

Property Value

System.Collections.Generic.IReadOnlyList<FormPage>