{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-cognitiveservices-face/face-find-similar":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_find_similar","summary":"Given query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large…","description":"POST /findsimilars","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"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-cognitiveservices-face/face-group":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_group","summary":"Divide candidate faces into groups based on face similarity. * The output is one or more disjointed face…","description":"POST /group","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"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-cognitiveservices-face/face-identify":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_identify","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","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"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-cognitiveservices-face/face-verify-face-to-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_verify_face_to_face","summary":"Verify whether two faces belong to a same person or whether one face belongs to a person. Remarks: * Higher…","description":"POST /verify","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"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-cognitiveservices-face/person-group-person-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_list","summary":"List all persons in a person group, and retrieve person information (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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"personGroupId","in":"query","required":true,"description":"Id referencing a particular person group.","schema":{"type":"string","description":"Id referencing a particular person group."}},{"name":"start","in":"query","required":false,"description":"Starting person id to return (used to list a range of persons).","schema":{"type":"string","description":"Starting person id to return (used to list a range of persons)."}},{"name":"top","in":"query","required":false,"description":"Number of persons to return starting with the person id indicated by the 'start' parameter.","schema":{"type":"integer","description":"Number of persons to return starting with the person id indicated by the 'start' parameter."}}],"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-cognitiveservices-face/person-group-person-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_create","summary":"Create a new person in a specified person group.","description":"POST /persongroups/{personGroupId}/persons","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"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-cognitiveservices-face/person-group-person-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_get","summary":"Retrieve a person's information, including registered persisted faces, name and userData.","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"personGroupId","in":"query","required":true,"description":"Id referencing a particular person group.","schema":{"type":"string","description":"Id referencing a particular person group."}},{"name":"personId","in":"query","required":true,"description":"Id referencing a particular person.","schema":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/person-group-person-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_update","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","personGroupId","personId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"personId":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/person-group-person-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_delete","summary":"Delete an existing person from a person group. The persistedFaceId, userData, person name and face feature…","description":"DELETE /persongroups/{personGroupId}/persons/{personId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","personId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"personId":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/person-group-person-get-face":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_get_face","summary":"Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging…","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"personGroupId","in":"query","required":true,"description":"Id referencing a particular person group.","schema":{"type":"string","description":"Id referencing a particular person group."}},{"name":"personId","in":"query","required":true,"description":"Id referencing a particular person.","schema":{"type":"string","description":"Id referencing a particular person."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Id referencing a particular persistedFaceId of an existing face.","schema":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/person-group-person-update-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_update_face","summary":"Add a face to a person into a person group for face identification or verification. To deal with an image…","description":"PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","personId","persistedFaceId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/person-group-person-delete-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_delete_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","personGroupId","personId","persistedFaceId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/person-group-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_get","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"personGroupId","in":"query","required":true,"description":"Id referencing a particular person group.","schema":{"type":"string","description":"Id referencing a particular person group."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/person-group-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_create","summary":"Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel. A…","description":"PUT /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"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-cognitiveservices-face/person-group-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_update","summary":"Update an existing person group's display name and userData. The properties which does not appear in request…","description":"PATCH /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"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-cognitiveservices-face/person-group-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_delete","summary":"Delete an existing person group. Persisted face features of all people in the person group will also be…","description":"DELETE /persongroups/{personGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."}}}}}},"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-cognitiveservices-face/person-group-get-training-status":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_get_training_status","summary":"Retrieve the training status of a person group (completed or ongoing).","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"personGroupId","in":"query","required":true,"description":"Id referencing a particular person group.","schema":{"type":"string","description":"Id referencing a particular person group."}}],"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-cognitiveservices-face/person-group-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_person_group_list","summary":"List person groups’ personGroupId, name, userData and recognitionModel. * Person groups are stored in…","description":"GET /persongroups","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"start","in":"query","required":false,"description":"List person groups from the least personGroupId greater than the \"start\".","schema":{"type":"string","description":"List person groups from the least personGroupId greater than the \"start\"."}},{"name":"top","in":"query","required":false,"description":"The number of person groups to list.","schema":{"type":"integer","default":1000,"description":"The number of person groups to list."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/person-group-train":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_train","summary":"Queue a person group training task, the training task may not be started immediately.","description":"POST /persongroups/{personGroupId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."}}}}}},"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-cognitiveservices-face/face-list-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_face_list_get","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"faceListId","in":"query","required":true,"description":"Id referencing a particular face list.","schema":{"type":"string","description":"Id referencing a particular face list."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/face-list-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_list_create","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","faceListId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"faceListId":{"type":"string","description":"Id referencing a particular face list."},"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-cognitiveservices-face/face-list-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_list_update","summary":"Update information of a face list.","description":"PATCH /facelists/{faceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","faceListId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"faceListId":{"type":"string","description":"Id referencing a particular face list."},"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-cognitiveservices-face/face-list-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_list_delete","summary":"Delete a specified face list.","description":"DELETE /facelists/{faceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","faceListId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"faceListId":{"type":"string","description":"Id referencing a particular face list."}}}}}},"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-cognitiveservices-face/face-list-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_face_list_list","summary":"List face lists’ faceListId, name, userData and recognitionModel. To get face information inside faceList…","description":"GET /facelists","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/face-list-delete-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_list_delete_face","summary":"Delete a face from a face list by specified faceListId and persistedFaceId. Adding/deleting faces to/from a…","description":"DELETE /facelists/{faceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","faceListId","persistedFaceId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"faceListId":{"type":"string","description":"Id referencing a particular face list."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/person-group-person-add-face-from-url":{"post":{"operationId":"cloud_azure_cognitiveservices_face_person_group_person_add_face_from_url","summary":"Add a face to a person into a person group for face identification or verification. To deal with an image…","description":"POST /persongroups/{personGroupId}/persons/{personId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","personGroupId","personId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"personGroupId":{"type":"string","description":"Id referencing a particular person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"userData":{"type":"string","description":"User-specified data about the face for any purpose. The maximum length is 1KB."},"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\". E.g.…"},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when…"}}}}}},"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-cognitiveservices-face/face-detect-with-url":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_detect_with_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"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"returnFaceId":{"type":"boolean","description":"A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires…"},"returnFaceLandmarks":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return landmarks of the detected faces."},"returnFaceAttributes":{"type":"array","description":"Analyze and return the one or more specified face attributes in the comma-separated string like \"returnFaceAttributes=age,gender\". The…"},"recognitionModel":{"type":"string","enum":["recognition_01","recognition_02","recognition_03","recognition_04"],"default":"recognition_01","description":"Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds,…"},"returnRecognitionModel":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when…"},"faceIdTimeToLive":{"type":"integer","default":86400,"description":"The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24…"}}}}}},"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-cognitiveservices-face/face-list-add-face-from-url":{"post":{"operationId":"cloud_azure_cognitiveservices_face_face_list_add_face_from_url","summary":"Add a face to a specified face list, up to 1,000 faces. To deal with an image contains multiple faces, input…","description":"POST /facelists/{faceListId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","faceListId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"faceListId":{"type":"string","description":"Id referencing a particular face list."},"userData":{"type":"string","description":"User-specified data about the face for any purpose. The maximum length is 1KB."},"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\". E.g.…"},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when…"}}}}}},"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-cognitiveservices-face/large-person-group-person-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_list","summary":"List all persons in a large person group, and retrieve person information (including personId, name,…","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largePersonGroupId","in":"query","required":true,"description":"Id referencing a particular large person group.","schema":{"type":"string","description":"Id referencing a particular large person group."}},{"name":"start","in":"query","required":false,"description":"Starting person id to return (used to list a range of persons).","schema":{"type":"string","description":"Starting person id to return (used to list a range of persons)."}},{"name":"top","in":"query","required":false,"description":"Number of persons to return starting with the person id indicated by the 'start' parameter.","schema":{"type":"integer","description":"Number of persons to return starting with the person id indicated by the 'start' parameter."}}],"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-cognitiveservices-face/large-person-group-person-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_create","summary":"Create a new person in a specified large person group.","description":"POST /largepersongroups/{largePersonGroupId}/persons","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largePersonGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"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-cognitiveservices-face/large-person-group-person-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_get","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largePersonGroupId","in":"query","required":true,"description":"Id referencing a particular large person group.","schema":{"type":"string","description":"Id referencing a particular large person group."}},{"name":"personId","in":"query","required":true,"description":"Id referencing a particular person.","schema":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/large-person-group-person-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_update","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","largePersonGroupId","personId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"personId":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/large-person-group-person-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_delete","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","largePersonGroupId","personId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"personId":{"type":"string","description":"Id referencing a particular 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-cognitiveservices-face/large-person-group-person-get-face":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_get_face","summary":"Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging…","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largePersonGroupId","in":"query","required":true,"description":"Id referencing a particular large person group.","schema":{"type":"string","description":"Id referencing a particular large person group."}},{"name":"personId","in":"query","required":true,"description":"Id referencing a particular person.","schema":{"type":"string","description":"Id referencing a particular person."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Id referencing a particular persistedFaceId of an existing face.","schema":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-person-group-person-update-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_update_face","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","largePersonGroupId","personId","persistedFaceId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-person-group-person-delete-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_delete_face","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","largePersonGroupId","personId","persistedFaceId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-person-group-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_get","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largePersonGroupId","in":"query","required":true,"description":"Id referencing a particular large person group.","schema":{"type":"string","description":"Id referencing a particular large person group."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/large-person-group-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_create","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","largePersonGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"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-cognitiveservices-face/large-person-group-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_update","summary":"Update an existing large person group's display name and userData. The properties which does not appear in…","description":"PATCH /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largePersonGroupId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"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-cognitiveservices-face/large-person-group-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_delete","summary":"Delete an existing large person group. Persisted face features of all people in the large person group will…","description":"DELETE /largepersongroups/{largePersonGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largePersonGroupId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."}}}}}},"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-cognitiveservices-face/large-person-group-get-training-status":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_get_training_status","summary":"Retrieve the training status of a large person group (completed or ongoing).","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largePersonGroupId","in":"query","required":true,"description":"Id referencing a particular large person group.","schema":{"type":"string","description":"Id referencing a particular large person group."}}],"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-cognitiveservices-face/large-person-group-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_list","summary":"List all existing large person groups’ largePersonGroupId, name, userData and recognitionModel. * Large…","description":"GET /largepersongroups","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"start","in":"query","required":false,"description":"List large person groups from the least largePersonGroupId greater than the \"start\".","schema":{"type":"string","description":"List large person groups from the least largePersonGroupId greater than the \"start\"."}},{"name":"top","in":"query","required":false,"description":"The number of large person groups to list.","schema":{"type":"integer","default":1000,"description":"The number of large person groups to list."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/large-person-group-train":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_train","summary":"Queue a large person group training task, the training task may not be started immediately.","description":"POST /largepersongroups/{largePersonGroupId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largePersonGroupId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."}}}}}},"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-cognitiveservices-face/large-person-group-person-add-face-from-url":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_person_group_person_add_face_from_url","summary":"Add a face to a person into a large person group for face identification or verification. To deal with an…","description":"POST /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largePersonGroupId","personId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largePersonGroupId":{"type":"string","description":"Id referencing a particular large person group."},"personId":{"type":"string","description":"Id referencing a particular person."},"userData":{"type":"string","description":"User-specified data about the face for any purpose. The maximum length is 1KB."},"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\". E.g.…"},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when…"}}}}}},"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-cognitiveservices-face/large-face-list-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_get","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largeFaceListId","in":"query","required":true,"description":"Id referencing a particular large face list.","schema":{"type":"string","description":"Id referencing a particular large face list."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}}],"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-cognitiveservices-face/large-face-list-create":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_create","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","largeFaceListId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."},"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-cognitiveservices-face/large-face-list-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_update","summary":"Update information of a large face list.","description":"PATCH /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."},"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-cognitiveservices-face/large-face-list-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_delete","summary":"Delete a specified large face list.","description":"DELETE /largefacelists/{largeFaceListId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."}}}}}},"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-cognitiveservices-face/large-face-list-get-training-status":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_get_training_status","summary":"Retrieve the training status of a large face list (completed or ongoing).","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largeFaceListId","in":"query","required":true,"description":"Id referencing a particular large face list.","schema":{"type":"string","description":"Id referencing a particular large face list."}}],"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-cognitiveservices-face/large-face-list-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_list","summary":"List large face lists’ information of largeFaceListId, name, userData and recognitionModel. To get face…","description":"GET /largefacelists","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"returnRecognitionModel","in":"query","required":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response.","schema":{"type":"boolean","default":false,"description":"A value indicating whether the operation should return 'recognitionModel' in response."}},{"name":"start","in":"query","required":false,"description":"Starting large face list id to return (used to list a range of large face lists).","schema":{"type":"string","description":"Starting large face list id to return (used to list a range of large face lists)."}},{"name":"top","in":"query","required":false,"description":"Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.","schema":{"type":"integer","description":"Number of large face lists to return starting with the large face list id indicated by the 'start' parameter."}}],"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-cognitiveservices-face/large-face-list-train":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_train","summary":"Queue a large face list training task, the training task may not be started immediately.","description":"POST /largefacelists/{largeFaceListId}/train","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."}}}}}},"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-cognitiveservices-face/large-face-list-get-face":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_get_face","summary":"Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largeFaceListId","in":"query","required":true,"description":"Id referencing a particular large face list.","schema":{"type":"string","description":"Id referencing a particular large face list."}},{"name":"persistedFaceId","in":"query","required":true,"description":"Id referencing a particular persistedFaceId of an existing face.","schema":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-face-list-update-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_update_face","summary":"Update a persisted face's userData field.","description":"PATCH /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId","persistedFaceId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-face-list-delete-face":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_delete_face","summary":"Delete a face from a large face list by specified largeFaceListId and persistedFaceId. Adding/deleting faces…","description":"DELETE /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId","persistedFaceId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."},"persistedFaceId":{"type":"string","description":"Id referencing a particular persistedFaceId of an existing 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-cognitiveservices-face/large-face-list-list-faces":{"get":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_list_faces","summary":"List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds…","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://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"largeFaceListId","in":"query","required":true,"description":"Id referencing a particular large face list.","schema":{"type":"string","description":"Id referencing a particular large face list."}},{"name":"start","in":"query","required":false,"description":"Starting face id to return (used to list a range of faces).","schema":{"type":"string","description":"Starting face id to return (used to list a range of faces)."}},{"name":"top","in":"query","required":false,"description":"Number of faces to return starting with the face id indicated by the 'start' parameter.","schema":{"type":"integer","description":"Number of faces to return starting with the face id indicated by the 'start' parameter."}}],"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-cognitiveservices-face/large-face-list-add-face-from-url":{"post":{"operationId":"cloud_azure_cognitiveservices_face_large_face_list_add_face_from_url","summary":"Add a face to a specified large face list, up to 1,000,000 faces. To deal with an image contains multiple…","description":"POST /largefacelists/{largeFaceListId}/persistedfaces","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","largeFaceListId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"largeFaceListId":{"type":"string","description":"Id referencing a particular large face list."},"userData":{"type":"string","description":"User-specified data about the face for any purpose. The maximum length is 1KB."},"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\". E.g.…"},"detectionModel":{"type":"string","enum":["detection_01","detection_02","detection_03"],"default":"detection_01","description":"Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when…"}}}}}},"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-cognitiveservices-face/snapshot-list":{"get":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_list","summary":"List all accessible snapshots with related information, including snapshots that were taken by the user, or…","description":"GET /snapshots","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"type","in":"query","required":false,"description":"User specified object type as a search filter.","schema":{"type":"string","enum":["FaceList","LargeFaceList","LargePersonGroup","PersonGroup"],"description":"User specified object type as a search filter."}},{"name":"applyScope","in":"query","required":false,"description":"User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot,…","schema":{"type":"array","description":"User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot,…"}}],"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-cognitiveservices-face/snapshot-take":{"post":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_take","summary":"Submit an operation to take a snapshot of face list, large face list, person group or large person group,…","description":"POST /snapshots","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"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-cognitiveservices-face/snapshot-get":{"get":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_get","summary":"Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it,…","description":"GET /snapshots/{snapshotId}","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"snapshotId","in":"query","required":true,"description":"Id referencing a particular snapshot.","schema":{"type":"string","description":"Id referencing a particular snapshot."}}],"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-cognitiveservices-face/snapshot-update":{"post":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_update","summary":"Update the information of a snapshot. Only the source subscription who took the snapshot can update the…","description":"PATCH /snapshots/{snapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","snapshotId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"snapshotId":{"type":"string","description":"Id referencing a particular snapshot."},"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-cognitiveservices-face/snapshot-delete":{"post":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_delete","summary":"Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot…","description":"DELETE /snapshots/{snapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","snapshotId"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"snapshotId":{"type":"string","description":"Id referencing a particular snapshot."}}}}}},"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-cognitiveservices-face/snapshot-apply":{"post":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_apply","summary":"Submit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions…","description":"POST /snapshots/{snapshotId}/apply","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Endpoint","snapshotId","body"],"properties":{"Endpoint":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."},"snapshotId":{"type":"string","description":"Id referencing a particular snapshot."},"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-cognitiveservices-face/snapshot-get-operation-status":{"get":{"operationId":"cloud_azure_cognitiveservices_face_snapshot_get_operation_status","summary":"Retrieve the status of a take/apply snapshot operation.","description":"GET /operations/{operationId}","tags":["cloud"],"parameters":[{"name":"Endpoint","in":"query","required":true,"description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).","schema":{"type":"string","description":"Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com)."}},{"name":"operationId","in":"query","required":true,"description":"Id referencing a particular take/apply snapshot operation.","schema":{"type":"string","description":"Id referencing a particular take/apply snapshot operation."}}],"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"}}},"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"}}}}}}}