formrecognizer Package

Packages

aio

Classes

AccountProperties	Summary of all the custom models on the account. New in version v2.1: Support for to_dict and from_dict methods
CustomFormModel	Represents a model trained from custom forms. New in version v2.1: The model_name and properties properties, support for to_dict and from_dict methods
CustomFormModelField	A field that the model will extract from forms it analyzes. New in version v2.1: Support for to_dict and from_dict methods
CustomFormModelInfo	Custom model information. New in version v2.1: The model_name and properties properties, support for to_dict and from_dict methods
CustomFormModelProperties	Optional model properties. New in version v2.1: Support for to_dict and from_dict methods
CustomFormSubmodel	Represents a submodel that extracts fields from a specific type of form. New in version v2.1: The model_id property, support for to_dict and from_dict methods
FieldData	Contains the data for the form field. This includes the text, location of the text on the form, and a collection of the elements that make up the text. New in version v2.1: FormSelectionMark is added to the types returned in the list of field_elements, support for to_dict and from_dict methods
FormElement	Base type which includes properties for a form element. New in version v2.1: Support for to_dict and from_dict methods
FormField	Represents a field recognized in an input form. New in version v2.1: Support for to_dict and from_dict methods
FormLine	An object representing an extracted line of text. New in version v2.1: appearance property, support for to_dict and from_dict methods
FormPage	Represents a page recognized from the input document. Contains lines, words, selection marks, tables and page metadata. New in version v2.1: selection_marks property, support for to_dict and from_dict methods
FormPageRange	The 1-based page range of the form. New in version v2.1: Support for to_dict and from_dict methods
FormRecognizerClient	FormRecognizerClient extracts information from forms and images into structured data. It is the interface to use for analyzing with prebuilt models (receipts, business cards, invoices, identity documents), recognizing content/layout from forms, and analyzing custom forms from trained models. It provides different methods based on inputs from a URL and inputs from a stream.
FormRecognizerError	Represents an error that occurred while training. New in version v2.1: Support for to_dict and from_dict methods
FormSelectionMark	Information about the extracted selection mark. New in version v2.1: Support for to_dict and from_dict methods
FormTable	Information about the extracted table contained on a page. New in version v2.1: The bounding_box property, support for to_dict and from_dict methods
FormTableCell	Represents a cell contained in a table recognized from the input document. New in version v2.1: FormSelectionMark is added to the types returned in the list of field_elements, support for to_dict and from_dict methods
FormTrainingClient	FormTrainingClient is the Form Recognizer interface to use for creating and managing custom models. It provides methods for training models on the forms you provide, as well as methods for viewing and deleting models, accessing account properties, copying models to another Form Recognizer resource, and composing models from a collection of existing models trained with labels.
FormWord	Represents a word recognized from the input document. New in version v2.1: Support for to_dict and from_dict methods
Point	The x, y coordinate of a point on a bounding box. New in version v2.1: Support for to_dict and from_dict methods
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. New in version v2.1: The form_type_confidence and model_id properties, support for to_dict and from_dict methods
TextAppearance	An object representing the appearance of the text line. New in version v2.1: Support for to_dict and from_dict methods
TrainingDocumentInfo	Report for an individual document used for training a custom model. New in version v2.1: The model_id property, support for to_dict and from_dict methods

Enums

CustomFormModelStatus	Status indicating the model's readiness for use.
FieldValueType	Semantic data type of the field value. New in version v2.1: The selectionMark and countryRegion values
FormContentType	Content type for upload. New in version v2.1: Support for image/bmp
FormRecognizerApiVersion	Form Recognizer API versions supported by this package
LengthUnit	The unit used by the width, height and bounding box properties. For images, the unit is "pixel". For PDF, the unit is "inch".
TrainingStatus	Status of the training operation.