Azure.AI.FormRecognizer.Models Namespace

Classes

FieldData

A form element representing text that is part of a FormField. This includes the location of the text in the form and a collection of the form elements that make up the text.

FormElement

Represents a form element recognized from the input document. Its text can be a line, a word, the content of a table cell, a selection mark, etc.

FormField

Represents a field recognized in an input form.

FormField<T>

Represents a field recognized in the input form, where the field's value is of a known type.

FormLine

Represents a line of text and its appearance.

FormPage

Represents a page recognized from the input document. Contains lines, words, tables, selection marks, and page metadata.

FormPageCollection

A read-only collection of FormPage objects.

FormRecognizerError

Represents an error that occurred during an operation in the Form Recognizer Azure Cognitive Service.

FormRecognizerModelFactory

A factory that builds Azure.AI.FormRecognizer model types used for mocking.

FormSelectionMark

Represents a Selection mark recognized from the input document.

FormTable

Represents a table recognized from the input document.

FormTableCell

Represents a cell contained in a table recognized from the input document.

FormWord

Represents a word recognized from the input document.

RecognizeBusinessCardsOperation

Tracks the status of a long-running operation for recognizing values from business cards.

RecognizeContentOperation

Tracks the status of a long-running operation for recognizing layout elements from forms.

RecognizeCustomFormsOperation

Tracks the status of a long-running operation for recognizing fields and other content from forms by using custom trained models.

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.

RecognizedFormCollection

A read-only collection of RecognizedForm objects.

RecognizeIdentityDocumentsOperation

Tracks the status of a long-running operation for recognizing values from identity documents.

RecognizeInvoicesOperation

Tracks the status of a long-running operation for recognizing values from invoices.

RecognizeReceiptsOperation

Tracks the status of a long-running operation for recognizing values from receipts.

TextAppearance

An object representing the appearance of the text line.

Structs

FieldBoundingBox

A sequence of four System.Drawing.PointF representing a quadrilateral that outlines the text of an element in a recognized form. Coordinates are specified relative to the top-left of the original image, and points are ordered clockwise from the top-left corner relative to the text orientation. Units are in pixels for images and inches for PDF. The LengthUnit type of a recognized page can be found at Unit.

FieldValue

Represents the strongly-typed value of a field recognized from the input document and provides methods for converting it to the appropriate type.

FormPageRange

Represents a page interval from the input document. Page numbers are 1-based.

TextStyleName

The text line style name, including handwriting and other.

Enums

FieldValueType

The type of the value of a FormField.

LengthUnit

The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch".

SelectionMarkState

State of a selection mark. i.e. Selected or Unselected.