FaceRectangle Class

A rectangle within which a face can be found.

All required parameters must be populated in order to send to server.

Inheritance

azure.ai.vision.face._model_base.Model

FaceRectangle

Constructor

FaceRectangle(*args: Any, **kwargs: Any)

Variables

Name	Description
top	int The distance from the top edge if the image to the top edge of the rectangle, in pixels. Required.
left	int The distance from the left edge if the image to the left edge of the rectangle, in pixels. Required.
width	int The width of the rectangle, in pixels. Required.
height	int The height of the rectangle, in pixels. Required.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

copy

copy() -> Model

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

items

items() -> ItemsView[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

keys

keys() -> KeysView[str]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

popitem

popitem() -> Tuple[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

update

update(*args: Any, **kwargs: Any) -> None

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

values

values() -> ValuesView[Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Attributes

height

The height of the rectangle, in pixels. Required.

height: int

left

The distance from the left edge if the image to the left edge of the rectangle, in pixels. Required.

left: int

top

The distance from the top edge if the image to the top edge of the rectangle, in pixels. Required.

top: int

width

The width of the rectangle, in pixels. Required.

width: int