FaceDetectionResult Class
Response for detect API.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.ai.vision.face._model_base.ModelFaceDetectionResult
Constructor
FaceDetectionResult(*args: Any, **kwargs: Any)
Variables
Name | Description |
---|---|
face_id
|
Unique faceId of the detected face, created by detection API and it will expire 24 hours after the detection call. To return this, it requires 'returnFaceId' parameter to be true. |
recognition_model
|
The 'recognitionModel' associated with this faceId. This is only returned when 'returnRecognitionModel' is explicitly set as true. Known values are: "recognition_01", "recognition_02", "recognition_03", and "recognition_04". |
face_rectangle
|
A rectangle area for the face location on image. Required. |
face_landmarks
|
An array of 27-point face landmarks pointing to the important positions of face components. To return this, it requires 'returnFaceLandmarks' parameter to be true. |
face_attributes
|
Face attributes for detected face. |
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
|
Whether to remove the readonly properties. |
Returns
Type | Description |
---|---|
A dict JSON compatible object |
clear
clear() -> None
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
copy
copy() -> Model
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
items
items() -> ItemsView[str, Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
keys
keys() -> KeysView[str]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
popitem
popitem() -> Tuple[str, Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
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
|
Whether to remove the readonly properties. |
update
update(*args: Any, **kwargs: Any) -> None
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
values
values() -> ValuesView[Any]
Keyword-Only Parameters
Name | Description |
---|---|
exclude_readonly
|
Whether to remove the readonly properties. |
Attributes
face_attributes
Face attributes for detected face.
face_attributes: _models.FaceAttributes | None
face_id
Unique faceId of the detected face, created by detection API and it will expire 24 hours after the detection call. To return this, it requires 'returnFaceId' parameter to be true.
face_id: str | None
face_landmarks
An array of 27-point face landmarks pointing to the important positions of face components. To return this, it requires 'returnFaceLandmarks' parameter to be true.
face_landmarks: _models.FaceLandmarks | None
face_rectangle
A rectangle area for the face location on image. Required.
face_rectangle: _models.FaceRectangle
recognition_model
The 'recognitionModel' associated with this faceId. This is only returned when 'returnRecognitionModel' is explicitly set as true. Known values are: "recognition_01", "recognition_02", "recognition_03", and "recognition_04".
recognition_model: str | _models.FaceRecognitionModel | None
Azure SDK for Python