Распознавание типов документов

Данный метод позволяет определить является ли фотография документом и возможный тип документа.

HOST: https://smarty.mail.ru

ENDPOINT: /api/v1/docs/detect

Авторизационные данные передаются в строке запроса:

Поддерживаемые провайдеры OAuth2:

Параметры запроса передаются в формате JSON в теле запроса с name="meta":

Параметры image_meta:

Изображения передаются в теле запроса, значения поля name должны соответствовать переданным в images.

Скопировать
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/docs/detect?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@docs_recognize_ok.jpg;type=image/jpeg' \  -F 'meta={  "images": [    {      "name": "file"    }  ]}'

Параметры response:

Параметры page:

Параметры doc:

Для каждого объекта (картинки) может быть несколько типов, с различной степенью уверенности. Метка «Документ» определяет является ли изображение документом и с какой вероятностью. На данный момент поддерживаются следующие типы документов:

Скопировать
{  "status": 200,  "body": {    "status": 0,    "objects": [      {        "status": 0,        "name": "file",        "pages": [          {            "index": 0,            "docs": [              {                "eng": "Pasport",                "rus": "Паспорт",                "probability": 0.475              }            ]          }        ]      }    ]  },  "htmlencoded": false,  "last_modified": 0}

Пример запроса:

Скопировать
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/docs/detect?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@docs_detect_ok_prava.jpg;type=image/jpeg' \  -F 'meta={  "images": [    {      "name": "file"    }  ]}'

Пример ответа:

Скопировать
{  "status": 200,  "body": {    "status": 0,    "objects": [      {        "status": 0,        "name": "file",        "pages": [          {            "index": 0,            "docs": [              {                "eng": "Voditelskye_prava",                "rus": "Водительские права",                "probability": 0.8387              }            ]          }        ]      }    ]  },  "htmlencoded": false,  "last_modified": 0}

Пример запроса:

Скопировать
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/docs/detect?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@persons_set_error_no_face.jpg;type=image/jpeg' \  -F 'meta={  "images": [    {      "name": "file"    }  ]}'

Пример ответа:

Скопировать
{  "status": 200,  "body": {    "status": 0,    "objects": [      {        "status": 0,        "name": "file",        "pages": [          {            "index": 0,            "docs": []          }        ]      }    ]  },  "htmlencoded": false,  "last_modified": 0}

Пример запроса:

Скопировать
curl -X 'POST' \  'https://smarty.mail.ru/api/v1/docs/detect?oauth_token=<ваш токен>&oauth_provider=mcs' \  -H 'accept: application/json' \  -H 'Content-Type: multipart/form-data' \  -F 'file=@docs_detect_ok_prava.jpg;type=image/jpeg' \  -F 'meta={  "images": [    {      "name": "file1"    }  ]}'

Пример ответа:

Скопировать
{  "status": 400,  "body": "could not get image by name file1: http: no such file",  "htmlencoded": false,  "last_modified": 0}