{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector Largepersongroups API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "Largepersongroups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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 large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person)."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Persons",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Create a new person in a specified large person group."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              }
            ]
          },
          "docs": "Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature."
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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 Largepersongroups Largepersongroupid Persons Personid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              },
              {
                "name": "personId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular person."
              }
            ]
          },
          "docs": "Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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 largePersonGroupId)."
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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": "Update a person persisted face's userData field."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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 large person group by specified largePersonGroupId, 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 Largepersongroups Largepersongroupid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use [LargePersonGroup Person - List](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/list) instead to retrieve person information under the large person group.<br>"
        },
        {
          "info": {
            "name": "Microsoft Azure Put Largepersongroups Largepersongroupid",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.<br> A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000<br>people.<br> After creation, use [LargePersonGroup Person - Create](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/create) to add person into the group, and call [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/facea"
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Update an existing large 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 Largepersongroups Largepersongroupid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Training",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/training",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Retrieve the training status of a large person group (completed or ongoing)."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largepersongroups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largepersongroups",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "List large person groups from the least largePersonGroupId greater than the \"start\"."
              },
              {
                "name": "top",
                "value": "",
                "type": "query",
                "description": "The number of large person groups to list."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "List all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.<br>* Large person groups are stored in alphabetical order of largePersonGroupId.<br>* \"start\" parameter (string, optional) is a user-provided largePersonGroupId 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 ret"
        },
        {
          "info": {
            "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Train",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/train",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large person group."
              }
            ]
          },
          "docs": "Queue a large person group training task, the training task may not be started immediately."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Persons Personid Persistedfaces",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces",
            "params": [
              {
                "name": "largePersonGroupId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large 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 large 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 [LargePersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/deleteface), [LargePersonGroup Person - De"
        }
      ]
    }
  ],
  "bundled": true
}