large_face_list

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

Overview

Name	large_face_list
Type	Resource
Id	azure.ai_vision_face.large_face_list

Fields

The following fields are returned by SELECT queries:

get_face

Name	Datatype	Description
persistedFaceId	string	Face ID of the face. Required.
userData	string	User-provided data attached to the face. The length limit is 1K.

get

Name	Datatype	Description
name	string	User defined name, maximum length is 128. Required.
largeFaceListId	string	Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. Required.
recognitionModel	string	Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds. Known values are: "recognition_01", "recognition_02", "recognition_03", and "recognition_04". (recognition_01, recognition_02, recognition_03, recognition_04)
userData	string	Optional user defined data. Length should not exceed 16K.

get_large_face_lists

Name	Datatype	Description
name	string	User defined name, maximum length is 128. Required.
largeFaceListId	string	Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. Required.
recognitionModel	string	Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds. Known values are: "recognition_01", "recognition_02", "recognition_03", and "recognition_04". (recognition_01, recognition_02, recognition_03, recognition_04)
userData	string	Optional user defined data. Length should not exceed 16K.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_face	select	large_face_list_id, persisted_face_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details.
get	select	large_face_list_id, endpoint, api_version	returnRecognitionModel	Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details.
get_large_face_lists	select	endpoint, api_version	start, top, returnRecognitionModel	List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-lists for more details.
create	insert	large_face_list_id, endpoint, api_version		Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/create-large-face-list for more details.
update	update	large_face_list_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list for more details.
delete	delete	large_face_list_id, endpoint, api_version		Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list for more details.
get_training_status	exec	large_face_list_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details.
delete_face	exec	large_face_list_id, persisted_face_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list-face for more details.
update_face	exec	large_face_list_id, persisted_face_id, endpoint, api_version		Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list-face for more details.
get_faces	exec	large_face_list_id, endpoint, api_version	start, top	List faces' persistedFaceId and userData in a specified Large Face List. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-faces for more details.
add_face_from_url	exec	large_face_list_id, endpoint, api_version	targetFace, detectionModel, userData	Add a face to a specified Large Face List, up to 1,000,000 faces. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face-from-url for more details.
train	exec	large_face_list_id, endpoint, api_version		Submit a Large Face List training task. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/train-large-face-list 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: )
large_face_list_id	string	Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. Required.
persisted_face_id	string	Face ID of the face. Required.
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'. Known values are: "detection_01", "detection_02", and "detection_03". Default value is None.
returnRecognitionModel	boolean	Return 'recognitionModel' or not. The default value is false. Default value is None.
start	string	List resources greater than the "start". It contains no more than 64 characters. Default is empty. Default value is None.
targetFace	array	A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. Default value is None.
top	integer	The number of items to list, ranging in [1, 1000]. Default is 1000. Default value is None.
userData	string	User-provided data attached to the face. The size limit is 1K. Default value is None.

SELECT examples

get_face

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details.

SELECT
persistedFaceId,
userData
FROM azure.ai_vision_face.large_face_list
WHERE large_face_list_id = '{{ large_face_list_id }}' -- required
AND persisted_face_id = '{{ persisted_face_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
;

get

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details.

SELECT
name,
largeFaceListId,
recognitionModel,
userData
FROM azure.ai_vision_face.large_face_list
WHERE large_face_list_id = '{{ large_face_list_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
AND returnRecognitionModel = '{{ returnRecognitionModel }}'
;

get_large_face_lists

List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-lists for more details.

SELECT
name,
largeFaceListId,
recognitionModel,
userData
FROM azure.ai_vision_face.large_face_list
WHERE endpoint = '{{ endpoint }}' -- required
AND api_version = '{{ api_version }}' -- required
AND start = '{{ start }}'
AND top = '{{ top }}'
AND returnRecognitionModel = '{{ returnRecognitionModel }}'
;

INSERT examples

create

Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/create-large-face-list for more details.

INSERT INTO azure.ai_vision_face.large_face_list (
large_face_list_id,
endpoint,
api_version
)
SELECT 
'{{ large_face_list_id }}',
'{{ endpoint }}',
'{{ api_version }}'
;

Manifest

# Description fields are for documentation purposes
- name: large_face_list
props:
  - name: large_face_list_id
    value: "{{ large_face_list_id }}"
    description: Required parameter for the large_face_list resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the large_face_list resource.
  - name: api_version
    value: "{{ api_version }}"
    description: Required parameter for the large_face_list resource.

UPDATE examples

update

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list for more details.

UPDATE azure.ai_vision_face.large_face_list
SET 
-- No updatable properties
WHERE 
large_face_list_id = '{{ large_face_list_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND api_version = '{{ api_version }}' --required;

DELETE examples

delete

Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list for more details.

DELETE FROM azure.ai_vision_face.large_face_list
WHERE large_face_list_id = '{{ large_face_list_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND api_version = '{{ api_version }}' --required
;

Lifecycle Methods

get_training_status

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details.

EXEC azure.ai_vision_face.large_face_list.get_training_status 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required
;

delete_face

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list-face for more details.

EXEC azure.ai_vision_face.large_face_list.delete_face 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@persisted_face_id='{{ persisted_face_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required
;

update_face

Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list-face for more details.

EXEC azure.ai_vision_face.large_face_list.update_face 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@persisted_face_id='{{ persisted_face_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required
;

get_faces

List faces' persistedFaceId and userData in a specified Large Face List. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-faces for more details.

EXEC azure.ai_vision_face.large_face_list.get_faces 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required, 
@start='{{ start }}', 
@top='{{ top }}'
;

add_face_from_url

Add a face to a specified Large Face List, up to 1,000,000 faces. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face-from-url for more details.

EXEC azure.ai_vision_face.large_face_list.add_face_from_url 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required, 
@targetFace='{{ targetFace }}', 
@detectionModel='{{ detectionModel }}', 
@userData='{{ userData }}'
;

train

Submit a Large Face List training task. Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/train-large-face-list for more details.

EXEC azure.ai_vision_face.large_face_list.train 
@large_face_list_id='{{ large_face_list_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@api_version='{{ api_version }}' --required
;