{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-ai-face/face-detection-operations-detect-from-url":{"post":{"operationId":"cloud_azure_ai_face_face_detection_operations_detect_from_url","summary":"Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and…","description":"POST /detect","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and…"},"recognitionModel":{"type":"string","enum":["recognition_01","recognition_02","recognition_03","recognition_04"],"default":"recognition_01","description":"The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01',…"},"returnFaceId":{"type":"boolean","default":true,"description":"Return faceIds of the detected faces or not. The default value is true."},"returnFaceAttributes":{"type":"array","description":"Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'.…"},"returnFaceLandmarks":{"type":"boolean","default":false,"description":"Return face landmarks of the detected faces or not. The default value is false."},"returnRecognitionModel":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true."},"faceIdTimeToLive":{"type":"integer","default":86400,"description":"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…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-create-liveness-session":{"post":{"operationId":"cloud_azure_ai_face_liveness_session_operations_create_liveness_session","summary":"Create a new detect liveness session.","description":"POST /detectLiveness-sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-get-liveness-session-result":{"get":{"operationId":"cloud_azure_ai_face_liveness_session_operations_get_liveness_session_result","summary":"Get session result of detectLiveness/singleModal call.","description":"GET /detectLiveness-sessions/{sessionId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"sessionId","in":"query","required":true,"description":"The unique ID to reference this session.","schema":{"type":"string","description":"The unique ID to reference this session."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-delete-liveness-session":{"post":{"operationId":"cloud_azure_ai_face_liveness_session_operations_delete_liveness_session","summary":"Delete all session related information for matching the specified session id.","description":"DELETE /detectLiveness-sessions/{sessionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","sessionId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"sessionId":{"type":"string","description":"The unique ID to reference this session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-create-liveness-with-verify-sess":{"post":{"operationId":"cloud_azure_ai_face_liveness_session_operations_create_liveness_with_verify_sess","summary":"Create a new liveness session with verify. Provide the verify image during session creation.","description":"POST /detectLivenessWithVerify-sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-get-liveness-with-verify-session":{"get":{"operationId":"cloud_azure_ai_face_liveness_session_operations_get_liveness_with_verify_session","summary":"Get session result of detectLivenessWithVerify/singleModal call.","description":"GET /detectLivenessWithVerify-sessions/{sessionId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"sessionId","in":"query","required":true,"description":"The unique ID to reference this session.","schema":{"type":"string","description":"The unique ID to reference this session."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-delete-liveness-with-verify-sess":{"post":{"operationId":"cloud_azure_ai_face_liveness_session_operations_delete_liveness_with_verify_sess","summary":"Delete all session related information for matching the specified session id.","description":"DELETE /detectLivenessWithVerify-sessions/{sessionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","sessionId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"sessionId":{"type":"string","description":"The unique ID to reference this session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-face-lists":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_face_lists","summary":"List Face Lists' faceListId, name, userData and recognitionModel. To get face information inside Face List…","description":"GET /facelists","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-face-list":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_face_list","summary":"Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.","description":"GET /facelists/{faceListId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"faceListId","in":"query","required":true,"description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.","schema":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-create-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_create_face_list","summary":"Create an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.","description":"PUT /facelists/{faceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","faceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"faceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-update-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_update_face_list","summary":"Update information of a Face List, including name and userData.","description":"PATCH /facelists/{faceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","faceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"faceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-delete-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_delete_face_list","summary":"Delete a specified Face List.","description":"DELETE /facelists/{faceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","faceListId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"faceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-add-face-list-face-from-url":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_add_face_list_face_from_url","summary":"Add a face to a specified Face List, up to 1,000 faces.","description":"POST /facelists/{faceListId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","faceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"faceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"targetFace":{"type":"array","description":"A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'."},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and…"},"userData":{"type":"string","description":"User-provided data attached to the face. The size limit is 1K."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-delete-face-list-face":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_delete_face_list_face","summary":"Delete a face from a Face List by specified faceListId and persistedFaceId.","description":"DELETE /facelists/{faceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","faceListId","persistedFaceId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"faceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"persistedFaceId":{"type":"string","description":"Face ID of the face."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-recognition-operations-find-similar":{"post":{"operationId":"cloud_azure_ai_face_face_recognition_operations_find_similar","summary":"Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains…","description":"POST /findsimilars","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-recognition-operations-group":{"post":{"operationId":"cloud_azure_ai_face_face_recognition_operations_group","summary":"Divide candidate faces into groups based on face similarity.","description":"POST /group","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-recognition-operations-identify-from-person-group":{"post":{"operationId":"cloud_azure_ai_face_face_recognition_operations_identify_from_person_group","summary":"1-to-many identification to find the closest matches of the specific query person face from a Person Group.","description":"POST /identify","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-large-face-lists":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_large_face_lists","summary":"List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.","description":"GET /largefacelists","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_large_face_list","summary":"Retrieve a Large Face List's largeFaceListId, name, userData and recognitionModel.","description":"GET /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largeFaceListId","in":"query","required":true,"description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.","schema":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-create-large-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_create_large_face_list","summary":"Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and…","description":"PUT /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-update-large-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_update_large_face_list","summary":"Update information of a Large Face List, including name and userData.","description":"PATCH /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-delete-large-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_delete_large_face_list","summary":"Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.","description":"DELETE /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-faces":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_large_face_list_faces","summary":"List faces' persistedFaceId and userData in a specified Large Face List.","description":"GET /largefacelists/{largeFaceListId}/persistedfaces","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largeFaceListId","in":"query","required":true,"description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.","schema":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-add-large-face-list-face-from-url":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_add_large_face_list_face_from_url","summary":"Add a face to a specified Large Face List, up to 1,000,000 faces.","description":"POST /largefacelists/{largeFaceListId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"targetFace":{"type":"array","description":"A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'."},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and…"},"userData":{"type":"string","description":"User-provided data attached to the face. The size limit is 1K."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-face":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_large_face_list_face","summary":"Retrieve persisted face in Large Face List by largeFaceListId and persistedFaceId.","description":"GET /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largeFaceListId","in":"query","required":true,"description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.","schema":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Face ID of the face.","schema":{"type":"string","description":"Face ID of the face."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-update-large-face-list-face":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_update_large_face_list_face","summary":"Update a specified face's userData field in a Large Face List by its persistedFaceId.","description":"PATCH /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId","persistedFaceId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"persistedFaceId":{"type":"string","description":"Face ID of the face."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-delete-large-face-list-face":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_delete_large_face_list_face","summary":"Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.","description":"DELETE /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId","persistedFaceId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."},"persistedFaceId":{"type":"string","description":"Face ID of the face."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-train-large-face-list":{"post":{"operationId":"cloud_azure_ai_face_face_list_operations_train_large_face_list","summary":"Submit a Large Face List training task.","description":"POST /largefacelists/{largeFaceListId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largeFaceListId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largeFaceListId":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-training-status":{"get":{"operationId":"cloud_azure_ai_face_face_list_operations_get_large_face_list_training_status","summary":"To check the Large Face List training status completed or still ongoing. Large Face List training is an…","description":"GET /largefacelists/{largeFaceListId}/training","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largeFaceListId","in":"query","required":true,"description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.","schema":{"type":"string","description":"Valid character is letter in lower case or digit or '-' or '_', maximum length is 64."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-groups":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_groups","summary":"List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.","description":"GET /largepersongroups","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_group","summary":"Retrieve the information of a Large Person Group, including its name, userData and recognitionModel. This…","description":"GET /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largePersonGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-create-large-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_create_large_person_group","summary":"Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and…","description":"PUT /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_large_person_group","summary":"Update an existing Large Person Group's name and userData. The properties keep unchanged if they are not in…","description":"PATCH /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_large_person_group","summary":"Delete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person…","description":"DELETE /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-persons":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_group_persons","summary":"List all persons' information in the specified Large Person Group, including personId, name, userData and…","description":"GET /largepersongroups/{largePersonGroupId}/persons","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largePersonGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-create-large-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_create_large_person_group_person","summary":"Create a new person in a specified Large Person Group. To add face to this person, please call \"Add Large…","description":"POST /largepersongroups/{largePersonGroupId}/persons","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-person":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_group_person","summary":"Retrieve a person's name and userData, and the persisted faceIds representing the registered person face…","description":"GET /largepersongroups/{largePersonGroupId}/persons/{personId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largePersonGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"personId","in":"query","required":true,"description":"ID of the person.","schema":{"type":"string","description":"ID of the person."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_large_person_group_person","summary":"Update name or userData of a person.","description":"PATCH /largepersongroups/{largePersonGroupId}/persons/{personId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","personId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_large_person_group_person","summary":"Delete an existing person from a Large Person Group. The persistedFaceId, userData, person name and face…","description":"DELETE /largepersongroups/{largePersonGroupId}/persons/{personId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","personId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-add-large-person-group-person-face-f":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_add_large_person_group_person_face_f","summary":"Add a face to a person into a Large Person Group for face identification or verification.","description":"POST /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","personId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"targetFace":{"type":"array","description":"A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'."},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and…"},"userData":{"type":"string","description":"User-provided data attached to the face. The size limit is 1K."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-person-face":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_group_person_face","summary":"Retrieve person face information. The persisted person face is specified by its largePersonGroupId, personId…","description":"GET /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largePersonGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"personId","in":"query","required":true,"description":"ID of the person.","schema":{"type":"string","description":"ID of the person."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Face ID of the face.","schema":{"type":"string","description":"Face ID of the face."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group-person-fac":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_large_person_group_person_fac","summary":"Update a person persisted face's userData field.","description":"PATCH /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","personId","persistedFaceId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"persistedFaceId":{"type":"string","description":"Face ID of the face."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group-person-fac":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_large_person_group_person_fac","summary":"Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and…","description":"DELETE /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId","personId","persistedFaceId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"persistedFaceId":{"type":"string","description":"Face ID of the face."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-train-large-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_train_large_person_group","summary":"Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group…","description":"POST /largepersongroups/{largePersonGroupId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","largePersonGroupId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"largePersonGroupId":{"type":"string","description":"ID of the container."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-training-stat":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_large_person_group_training_stat","summary":"To check Large Person Group training status completed or still ongoing. Large Person Group training is an…","description":"GET /largepersongroups/{largePersonGroupId}/training","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"largePersonGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-groups":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_groups","summary":"List Person Groups' personGroupId, name, userData and recognitionModel.","description":"GET /persongroups","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-group":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_group","summary":"Retrieve Person Group name, userData and recognitionModel. To get person information under this personGroup,…","description":"GET /persongroups/{personGroupId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"personGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"Return 'recognitionModel' or not. The default value is false.","schema":{"type":"boolean","default":false,"description":"Return 'recognitionModel' or not. The default value is false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-create-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_create_person_group","summary":"Create a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.","description":"PUT /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_person_group","summary":"Update an existing Person Group's name and userData. The properties keep unchanged if they are not in…","description":"PATCH /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_person_group","summary":"Delete an existing Person Group with specified personGroupId. Persisted data in this Person Group will be…","description":"DELETE /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-group-persons":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_group_persons","summary":"List all persons' information in the specified Person Group, including personId, name, userData and…","description":"GET /persongroups/{personGroupId}/persons","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"personGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"start","in":"query","required":false,"description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty.","schema":{"type":"string","description":"List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."}},{"name":"top","in":"query","required":false,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000.","schema":{"type":"integer","default":1000,"description":"The number of items to list, ranging in [1, 1000]. Default is 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-create-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_create_person_group_person","summary":"Create a new person in a specified Person Group. To add face to this person, please call \"Add Person Group…","description":"POST /persongroups/{personGroupId}/persons","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-group-person":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_group_person","summary":"Retrieve a person's name and userData, and the persisted faceIds representing the registered person face…","description":"GET /persongroups/{personGroupId}/persons/{personId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"personGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"personId","in":"query","required":true,"description":"ID of the person.","schema":{"type":"string","description":"ID of the person."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_person_group_person","summary":"Update name or userData of a person.","description":"PATCH /persongroups/{personGroupId}/persons/{personId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","personId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-person-group-person":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_person_group_person","summary":"Delete an existing person from a Person Group. The persistedFaceId, userData, person name and face…","description":"DELETE /persongroups/{personGroupId}/persons/{personId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","personId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-add-person-group-person-face-from-ur":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_add_person_group_person_face_from_ur","summary":"Add a face to a person into a Person Group for face identification or verification.","description":"POST /persongroups/{personGroupId}/persons/{personId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","personId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"targetFace":{"type":"array","description":"A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'."},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and…"},"userData":{"type":"string","description":"User-provided data attached to the face. The size limit is 1K."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-group-person-face":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_group_person_face","summary":"Retrieve person face information. The persisted person face is specified by its personGroupId, personId and…","description":"GET /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"personGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}},{"name":"personId","in":"query","required":true,"description":"ID of the person.","schema":{"type":"string","description":"ID of the person."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Face ID of the face.","schema":{"type":"string","description":"Face ID of the face."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-update-person-group-person-face":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_update_person_group_person_face","summary":"Update a person persisted face's userData field.","description":"PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","personId","persistedFaceId","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"persistedFaceId":{"type":"string","description":"Face ID of the face."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-delete-person-group-person-face":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_delete_person_group_person_face","summary":"Delete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.","description":"DELETE /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId","personId","persistedFaceId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."},"personId":{"type":"string","description":"ID of the person."},"persistedFaceId":{"type":"string","description":"Face ID of the face."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-train-person-group":{"post":{"operationId":"cloud_azure_ai_face_person_group_operations_train_person_group","summary":"Submit a Person Group training task. Training is a crucial step that only a trained Person Group can be used…","description":"POST /persongroups/{personGroupId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","personGroupId"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"personGroupId":{"type":"string","description":"ID of the container."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/person-group-operations-get-person-group-training-status":{"get":{"operationId":"cloud_azure_ai_face_person_group_operations_get_person_group_training_status","summary":"To check Person Group training status completed or still ongoing. Person Group training is an asynchronous…","description":"GET /persongroups/{personGroupId}/training","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"personGroupId","in":"query","required":true,"description":"ID of the container.","schema":{"type":"string","description":"ID of the container."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/liveness-session-operations-get-session-image":{"get":{"operationId":"cloud_azure_ai_face_liveness_session_operations_get_session_image","summary":"Get session image stored during the liveness session.","description":"GET /sessionImages/{sessionImageId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."}},{"name":"apiVersion","in":"query","required":true,"description":"API Version","schema":{"type":"string","enum":["v1.2"],"description":"API Version"}},{"name":"sessionImageId","in":"query","required":true,"description":"The request ID of the image to be retrieved","schema":{"type":"string","description":"The request ID of the image to be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-ai-face/face-recognition-operations-verify-face-to-face":{"post":{"operationId":"cloud_azure_ai_face_face_recognition_operations_verify_face_to_face","summary":"Verify whether two faces belong to a same person.","description":"POST /verify","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","apiVersion","body"],"properties":{"endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com)."},"apiVersion":{"type":"string","enum":["v1.2"],"description":"API Version"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}