Face recognition

HOST: https://smarty.mail.ru

Four API methods are used for face recognition:

• set (/api/v1/persons/set);
• recognize (/api/v1/persons/recognize);
• delete (/api/v1/persons/delete);
• truncate (/api/v1/persons/truncate).

Let's consider each of them in more detail.

This method allows you to establish a link between a given photo and a specific person_id.

Authorization data is passed in the query string:

Supported OAuth2 providers:

Request parameters are passed in JSON format in the request body with name="meta":

The space parameter is used to avoid intersections by person. So person1 from space 0 and person1 from space 1 are different. For applications that solve different problems, it makes sense to use different values ​​of space.

A client can have up to 10 different spaces. Space values ​​range from 0 to 9. If the limit is exceeded, an error will be returned.

image_meta parameters:

Copy
curl -X 'POST' "https://smarty.mail.ru/api/v1/persons/set?oauth_token=<ваш токен>&oauth_provider=mcs"      \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@persons_set_ok.jpg;type=image/jpeg' \  -F 'meta={  "space": "5",  "images": [    {      "name": "file",      "person_id": 1    }  ]}'

response parameters:

object parameters:

status parameters:

Copy
{  "status": 200,  "body": {    "objects": [      {        "status": 0,        "name": "file"      }    ]  },  "htmlencoded": false,  "last_modified": 0}

This method allows you to recognize a person from a given photo. If no match is found, a new person will be added.

AuthorizationThis data is passed in the query string:

Supported OAuth2 providers:

Request parameters are passed in JSON format in the request body with name="meta":

For a description of the space parameter, see the section of the Set method.

image_meta parameters:

Images are passed in the body of the request, the values ​​of the name field must match those passed in images.

Copy
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/persons/recognize?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@persons_recognize_ok_person_in_db.jpg;type=image/jpeg' \  -F 'meta={  "space": "5",  "create_new": false,  "images": [    {      "name": "file"    }  ]}'

response parameters:

object parameters:

status parameters:

person parameters:

For the second model only:

The value of tag may equal undefined if the value of create_new in the request was false and no corresponding person was found in the database for the provided image.

Copy
{  "status": 200,  "body": {    "objects": [      {        "status": 0,        "name": "file",        "persons": [          {            "tag": "person1",            "coord": [              567,              376,              992,              931            ],            "confidence": 0.99917,            "awesomeness": 0.4894,            "similarity": 0.9721,            "sex": "male",            "emotion": "Neutral",            "age": 34,            "valence": -0.3236,            "arousal": 0.185,            "frontality": 0.8921,            "visibility": 0.9985          }        ]      }    ]  },  "htmlencoded": false,  "last_modified": 0}

This method allows you to remove the association between a photo and person_id.

Authorization data is passed in the query string:

Supported OAuth2 providers:

Request parameters are passed in JSON format in the request body with name="meta":

For a description of the space parameter, see the section of the Set method.

image_meta parameters:

Images are passed in the body of the request, the values ​​of the name field must match those passed in images.

Copy
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/persons/delete?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'meta={  "space": "5",  "images": [    {      "name": "aaa",      "person_id": 1    }  ]}'

response parameters:

object parameters:

status parameters:

Copy
{  "status": 200,  "body": {    "objects": [      {        "status": 0,        "name": "aaa"      }    ]  },  "htmlencoded": false,  "last_modified": 0}

This method allows you to completely clear the space.

Authorization data is passed in the query string:

Supported OAuth2 providers:

Request parameters are passed in JSON format in the request body with name="meta":

For a description of the space parameter, see the section of the Set method.

This request does not require the transfer of images.

Copy
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/persons/truncate?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'meta={  "space": "5"}'

Copy
{  "status": 200,  "body": {},  "htmlencoded": false,  "last_modified": 0}