FormPageRange Class

The 1-based page range of the form.

New in version v2.1: Support for to_dict and from_dict methods

Inheritance

azure.ai.formrecognizer._models.FormPageRange

FormPageRange

Constructor

FormPageRange(first_page_number: int, last_page_number: int)

Parameters

Name	Description
first_page_number Required
last_page_number Required

Methods

count	Return number of occurrences of value.
from_dict	Converts a dict in the shape of a FormPageRange to the model itself.
index	Return first index of value. Raises ValueError if the value is not present.
to_dict	Returns a dict representation of FormPageRange.

count

Return number of occurrences of value.

count(value, /)

Positional-Only Parameters

Name	Description
value Required

from_dict

Converts a dict in the shape of a FormPageRange to the model itself.

from_dict(data: Dict) -> FormPageRange

Positional-Only Parameters

Name	Description
value Required

Parameters

Name	Description
data Required	dict A dictionary in the shape of FormPageRange.

Returns

Type	Description
FormPageRange	FormPageRange

index

Return first index of value.

Raises ValueError if the value is not present.

index(value, start=0, stop=9223372036854775807, /)

Positional-Only Parameters

Name	Description
value Required
start	Default value: 0
stop	Default value: 9223372036854775807

to_dict

Returns a dict representation of FormPageRange.

to_dict() -> Dict

Positional-Only Parameters

Name	Description
value Required

Returns

Type	Description
dict	dict

Attributes

first_page_number

The first page number of the form.

first_page_number: int

last_page_number

The last page number of the form.

last_page_number: int