Құжат өрістерін тану
Бұл әдіс, мысалы, фотодағы паспорт өрістерін тануға мүмкіндік береді. Төменде оның қолданылуын толығырақ қарастырамыз.
HOST: https://smarty.mail.ru
ENDPOINT: /api/v1/docs/recognize
Авторизация деректері сұрау жолында беріледі:
Параметр | Түрі | Мәні |
|---|---|---|
oauth_token | string | OAuth2 access token (required non-empty) |
oauth_provider | string | OAuth2 провайдері (required non-empty) |
Қолдау көрсетілетін OAuth2 провайдерлері:
Провайдер | oauth_provider мәні | Токенді алу |
|---|---|---|
VK Cloud | mcs | мақаланы қараңыз |
Сұрау параметрлері сұрау денесінде name="meta" арқылы JSON форматында беріледі:
Параметр | Түрі | Мәні |
|---|---|---|
images | []image_meta | Берілетін кескіндердің метадеректері (required non-empty) |
image_meta параметрлері:
Параметр | Түрі | Мәні |
|---|---|---|
name | string | Сұрау мен жауаптағы файлдарды сәйкестендіруге арналған файл атаулары (required non-empty) |
Кескіндер сұрау денесінде беріледі, name өрісінің мәндері images ішінде берілген мәндерге сәйкес келуі керек.
curl -X 'POST' 'https://smarty.mail.ru/api/v1/docs/recognize?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"}]}'
Параметр | Түрі | Мәні |
|---|---|---|
status | int | Сәтті болған жағдайда 200, әйтпесе қате сипаттамасы body ішінде келтіріледі |
body | string | response | Жауап денесі |
response параметрлері:
Параметр | Түрі | Мәні |
|---|---|---|
objects | []object | Әр файл үшін жауаптар массиві |
object параметрлері:
Параметр | Түрі | Мәні |
|---|---|---|
status | enum | Орындау нәтижесі: - 0 — сәтті;- 1 — тұрақты қате;- 2 — уақытша қате |
error | string | Қатенің мәтіндік сипаттамасы (опционалды) |
name | string | Сұрау мен жауаптағы файлдарды сәйкестендіруге арналған файл атауы |
labels | object | Танылған құжат өрістері |
{"status": 200,"body": {"objects": [{"status": 0,"name": "file","labels": {"birthday": ["10.04.1990"],"birthplace": ["ГОР.","МОСКВА"],"code_of_issue": ["459-653"],"date_of_issue": ["11.11.1995"],"first_name": ["ФОМА"],"last_name": ["КИНЯЕВ"],"middle_name": ["СЕМЕНОВИЧ"],"number": ["233675"],"place_of_issue": ["ГОРОДА","МОСКВЫ","ОДИНЦОВСКОГО","РАЙОНА","ОТДЕЛОМ","ВНУТРЕННИХ","ДЕЛ"],"series_number": ["560Р"],"sex": ["МУЖ."]}}]},"htmlencoded": false,"last_modified": 0}
Сұрау мысалы:
curl -X 'POST' 'https://smarty.mail.ru/api/v1/docs/recognize?oauth_token=<ваш токен>&oauth_provider=mcs' -H 'accept: application/json' -H 'Content-Type: multipart/form-data' -F 'file=@docs_recognize_not_doc.jpg;type=image/jpeg' -F 'meta={"images": [{"name": "file"}]}'
Жауап мысалы:
{"status": 200,"body": {"objects": [{"status": 0,"name": "file","labels": {}}]},"htmlencoded": false,"last_modified": 0}
Сұрау мысалы:
curl -X 'POST' 'https://smarty.mail.ru/api/v1/docs/recognize?oauth_token=<ваш токен>&oauth_provider=mcs' -H 'accept: application/json' -H 'Content-Type: multipart/form-data' -F 'file=@empty.jpg;type=image/jpeg' -F 'meta={"images": [{"name": "file"}]}'
Жауап мысалы:
{"status": 400,"body": "could not get image by name file1: http: no such file","htmlencoded": false,"last_modified": 0}
Сұрау мысалы:
curl -X 'POST' 'https://smarty.mail.ru/api/v1/docs/recognize?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={"images": [{"name": "file1"}]}'
Жауап мысалы:
{"status": 400,"body": "could not get image by name file1: http: no such file","htmlencoded": false,"last_modified": 0}