FaceFindSimilarResult Class

Response body for find similar face operation.

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

Inheritance

azure.ai.vision.face._model_base.Model

FaceFindSimilarResult

Constructor

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

Variables

Name	Description
confidence	float Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1]. Required.
face_id	str faceId of candidate face when find by faceIds. faceId is created by "Detect" and will expire 24 hours after the detection call.
persisted_face_id	str persistedFaceId of candidate face when find by faceListId or largeFaceListId. persistedFaceId in face list/large face list is persisted and will not expire.

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

confidence

Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1]. Required.

confidence: float

face_id

faceId of candidate face when find by faceIds. faceId is created by "Detect" and will expire 24 hours after the detection call.

face_id: str | None

persisted_face_id

persistedFaceId of candidate face when find by faceListId or largeFaceListId. persistedFaceId in face list/large face list is persisted and will not expire.

persisted_face_id: str | None