{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector Largefacelists API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "Largefacelists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Get Largefacelists Largefacelistid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel."
        },
        {
          "info": {
            "name": "Microsoft Azure Put Largefacelists Largefacelistid",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              }
            ]
          },
          "docs": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.<br> Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar).<br> After creation, user should use [LargeFaceList Face - Add](https://docs.microsoft.com/rest/api/faceapi/largefacelist/addfacefromurl) to import the faces and [LargeFaceList - Train](https://docs.microsoft.com/rest/api/f"
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Largefacelists Largefacelistid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              }
            ]
          },
          "docs": "Update information of a large face list."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Largefacelists Largefacelistid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              }
            ]
          },
          "docs": "Delete a specified large face list."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largefacelists Largefacelistid Training",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/training",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              }
            ]
          },
          "docs": "Retrieve the training status of a large face list (completed or ongoing)."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largefacelists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largefacelists",
            "params": [
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Starting large face list id to return (used to list a range of large face lists)."
              },
              {
                "name": "top",
                "value": "",
                "type": "query",
                "description": "Number of large face lists to return starting with the large face list id indicated by the 'start' parameter."
              }
            ]
          },
          "docs": "List large face lists’ information of largeFaceListId, name, userData and recognitionModel.  <br>To get face information inside largeFaceList use [LargeFaceList Face - Get](https://docs.microsoft.com/rest/api/faceapi/largefacelist/getface)<br>* Large face lists are stored in alphabetical order of largeFaceListId.<br>* \"start\" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return fr"
        },
        {
          "info": {
            "name": "Microsoft Azure Post Largefacelists Largefacelistid Train",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/train",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              }
            ]
          },
          "docs": "Queue a large face list training task, the training task may not be started immediately."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largefacelists Largefacelistid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "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 and its belonging largeFaceListId)."
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Largefacelists Largefacelistid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Update a persisted face's userData field."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Largefacelists Largefacelistid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Delete a face from a large face list by specified largeFaceListId and persistedFaceId.<br> Adding/deleting faces to/from a same large face list are processed sequentially and to/from different large face lists are in parallel."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Largefacelists Largefacelistid Persistedfaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Starting face id to return (used to list a range of faces)."
              },
              {
                "name": "top",
                "value": "",
                "type": "query",
                "description": "Number of faces to return starting with the face id indicated by the 'start' parameter."
              }
            ]
          },
          "docs": "List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face)."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Largefacelists Largefacelistid Persistedfaces",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces",
            "params": [
              {
                "name": "largeFaceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular large face list."
              },
              {
                "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 specified large face list, up to 1,000,000 faces.<br> 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 [LargeFaceList Face - Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/deleteface) or [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/face"
        }
      ]
    }
  ],
  "bundled": true
}