detect_from_session_images

Creates, updates, deletes, gets or lists a detect_from_session_images resource.

Overview

Name	detect_from_session_images
Type	Resource
Id	azure.ai_vision_face.detect_from_session_images

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
detect_from_session_image	exec	endpoint, api_version	detectionModel, recognitionModel, returnFaceId, returnFaceAttributes, returnFaceLandmarks, returnRecognitionModel, faceIdTimeToLive	Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. Please refer to https://learn.microsoft.com/rest/api/face/face-detection-operations/detect-from-session-image-id for more details.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_version	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client apiVersion parameter. (default: )
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
detectionModel	string	The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations. Known values are: "detection_01", "detection_02", and "detection_03". Default value is None.
faceIdTimeToLive	integer	The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). Default value is None.
recognitionModel	string	The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. Known values are: "recognition_01", "recognition_02", "recognition_03", and "recognition_04". Default value is None.
returnFaceAttributes	array	Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and time cost. Default value is None.
returnFaceId	boolean	Return faceIds of the detected faces or not. The default value is true. Default value is None.
returnFaceLandmarks	boolean	Return face landmarks of the detected faces or not. The default value is false. Default value is None.
returnRecognitionModel	boolean	Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true. Default value is None.

Lifecycle Methods

detect_from_session_image

Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. Please refer to https://learn.microsoft.com/rest/api/face/face-detection-operations/detect-from-session-image-id for more details.

EXEC azure.ai_vision_face.detect_from_session_images.detect_from_session_image 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required, 
@detectionModel='{{ detectionModel }}', 
@recognitionModel='{{ recognitionModel }}', 
@returnFaceId={{ returnFaceId }}, 
@returnFaceAttributes='{{ returnFaceAttributes }}', 
@returnFaceLandmarks={{ returnFaceLandmarks }}, 
@returnRecognitionModel={{ returnRecognitionModel }}, 
@faceIdTimeToLive='{{ faceIdTimeToLive }}'
;