VK Cloud logo

Құжаттардағы мәтінді тану

Бұл әдіс кескіндегі мәтінді тануға мүмкіндік береді.

HOST: https://smarty.mail.ru

ENDPOINT: /api/v1/text/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)
mode
string
Параметр-жалау: егжей-тегжейлі жауап беру керек пе, егер "detailed" болса, онда егжей-тегжейлі жауап беріледі (жауапқа мәтіннің bounding box координаттары мен confidence қосылады), (optional)

image_meta параметрлері:

Параметр
Тип
Мәні
name
string
сұрау мен жауаптағы файлдарды сәйкестендіруге арналған файл атаулары (required non-empty)

Кескіндер сұрау денесінде беріледі, name өрісінің мәндері images ішінде берілгендерге сәйкес келуі керек.

Сұрау үлгісі

curl -X 'POST' \  'https://smarty.mail.ru/api/v1/text/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
int
Vision серверлерімен өзара әрекеттесу сәтті болған жағдайда 200
body
response
Жауап денесі

response параметрлері:

Параметр
Тип
Мәні
objects
[]object
Әр файл үшін жауаптар массиві

object параметрлері:

Параметр
Тип
Мәні
status
enum
Орындау нәтижесі:
- 0 — сәтті;
- 1 — тұрақты қате;
- 2 — уақытша қате
error
string
Қатенің мәтіндік сипаттамасы (optional)
name
string
Сұрау мен жауаптағы файлдарды сәйкестендіруге арналған файл атауы
text
string
Танылған мәтін
results
[]line
Егер "mode":"detailed" көрсетілсе — бет бойынша жауап жолдарының массиві (мәтін, bounding box, confidence)

line параметрлері:

Параметр
Тип
Мәні
line_prob
float32
Жолды тану сенімділігі
line_coord
[]float32
Жол координаттары - x1,y1, x2, y2 - қамтушы тіктөртбұрыштың сол жақ жоғарғы және оң жақ төменгі нүктелері
words
[]word
Жолдағы танылған сөздердің жауаптар массиві

word параметрлері:

Параметр
Тип
Мәні
prob
float32
Сөзді тану сенімділігі
coord
[]float32
Сөз координаттары - x1,y1, x2, y2 - қамтушы тіктөртбұрыштың сол жақ жоғарғы және оң жақ төменгі нүктелері
text
string
Жолдағы танылған сөздердің жауаптар массиві
lang_prob
float32
Тілді тану сенімділігі
lang
string
Eng/rus/unknown. Unknown әліпби әріптері болмаған кезде

Жауап үлгісі

{  "status": 200,  "body": {    "objects": [      {        "status": 0,        "name": "file",        "text": "Когда пришла весна,\nнаступили теплые дни. Там,\nгде раньше лежал снег,\nвесело бегут ручьи. Куда\nни взглянешь, всюду\nрасцветают подснежники.\nЕсли посмотреть на\nвесеннее небо, то можно\nувидеть стаи птиц,\nлетящих с юга. Когда\nпросыпается природа от\nзимнего сна, лес\nнаполняется весенней"      }    ]  },  "htmlencoded": false,  "last_modified": 0}

Қосымша мысалдар

mode=detailed

Сұрау үлгісі:

curl -X 'POST' \  'https://smarty.mail.ru/api/v1/text/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={  "mode": "detailed",  "images": [    {      "name": "file"    }  ]}'

Кескінде мәтін жоқ

Сұрау үлгісі:

curl -X 'POST' \  'https://smarty.mail.ru/api/v1/text/recognize?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={  "mode": "detailed",  "images": [    {      "name": "file"    }  ]}'

Жауап үлгісі:

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

Бос кескін

Сұрау үлгісі:

curl -X 'POST' \  'https://smarty.mail.ru/api/v1/text/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={  "mode": "detailed",  "images": [    {      "name": "file"    }  ]}'

Жауап үлгісі:

{  "status": 400,  "body": "empty image",  "htmlencoded": false,  "last_modified": 0}

Дұрыс емес JSON

Сұрау үлгісі:

curl -X 'POST' \  'https://smarty.mail.ru/api/v1/text/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={  "mode": "detailed",  "images": [    {      "name": "file1"    }  ]}'

Жауап үлгісі:

{  "status": 400,  "body": "could not get image by name file1: http: no such file",  "htmlencoded": false,  "last_modified": 0}