{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector Persongroups API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "Persongroups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups Persongroupid Persons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Starting person id to return (used to list a range of persons)."
              },
              {
                "name": "top",
                "value": "",
                "type": "query",
                "description": "Number of persons to return starting with the person id indicated by the 'start' parameter."
              }
            ]
          },
          "docs": "List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person)."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Persongroups Persongroupid Persons",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Create a new person in a specified person group."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups Persongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              }
            ]
          },
          "docs": "Retrieve a person's information, including registered persisted faces, name and userData."
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Persongroups Persongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              }
            ]
          },
          "docs": "Update name or userData of a person."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Persongroups Persongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              }
            ]
          },
          "docs": "Delete an existing person from a person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId)."
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.mi"
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Delete a face from a person in a person group by specified personGroupId, personId and persistedFaceId.<br> Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups Persongroupid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups/:personGroupId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person - List](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/list)."
        },
        {
          "info": {
            "name": "Microsoft Azure Put Persongroups Persongroupid",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/persongroups/:personGroupId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.<br> A person group is the container of the uploaded person data, including face recognition features.<br> After creation, use [PersonGroup Person - Create](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/create) to add persons into the group, and then call [PersonGroup - Train](https://docs.microsoft.com/rest/api/faceapi/persongroup/train) to get this group ready for [Face - I"
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Persongroups Persongroupid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/persongroups/:personGroupId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Persongroups Persongroupid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/persongroups/:personGroupId",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Delete an existing person group. Persisted face features of all people in the person group will also be deleted."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups Persongroupid Training",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups/:personGroupId/training",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Retrieve the training status of a person group (completed or ongoing)."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Persongroups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/persongroups",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "List person groups from the least personGroupId greater than the \"start\"."
              },
              {
                "name": "top",
                "value": "",
                "type": "query",
                "description": "The number of person groups to list."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "List person groups’ personGroupId, name, userData and recognitionModel.<br>* Person groups are stored in alphabetical order of personGroupId.<br>* \"start\" parameter (string, optional) is a user-provided personGroupId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.<br>* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you ca"
        },
        {
          "info": {
            "name": "Microsoft Azure Post Persongroups Persongroupid Train",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/persongroups/:personGroupId/train",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              }
            ]
          },
          "docs": "Queue a person group training task, the training task may not be started immediately."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Persongroups Persongroupid Persons Personid Persistedfaces",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces",
            "params": [
              {
                "name": "personGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              },
              {
                "name": "userData",
                "value": "",
                "type": "query",
                "description": "User-specified data about the face for any purpose. The maximum length is 1KB."
              },
              {
                "name": "targetFace",
                "value": "",
                "type": "query",
                "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. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image."
              },
              {
                "name": "detectionModel",
                "value": "",
                "type": "query",
                "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it."
              }
            ]
          },
          "docs": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.mi"
        }
      ]
    }
  ],
  "bundled": true
}