ImageToText POST GET

Преобразует изображение в набор печатных символов.


Запросы следует отправлять на адрес:

Поддерживаются запросы методом GET и POST.

По умолчанию ответ сервера будет в формате JSON. Для получения ответа в другом формате, можно добавить расширение к файлу в адресе: .xml, .html или .txt. Например: /v2/ImageToText.xml Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
type AscArtType Нет Text Тип преобразования.
file File Условно NULL Файл, который необходимо обработать.
url String Условно NULL Адрес, который необходимо обработать.
chars String Нет ##@%=+*:-.[space] Набор символов, который следует использовать.
color Colors Нет BlackWhite Цветовая схема.
size Int32 Нет 500 Максимальный размер обрабатываемого изображения.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.

Имя параметра Тип Обязательный По умолчанию Описание
appId Int32 Нет NULL Идентификатор приложения.
appSecret String Условно NULL Секретный ключ приложения.
token String Нет NULL Маркер доступа клиента, полученный методом GetToken.
formatting ResponseFormatting Нет None Определяет параметры форматирования выдачи результатов.
details Boolean Нет False Позволяет отобразить дополнительную информацию о запросе.
cp String Нет UTF-8 Имя кодовой страницы.
lang Language Нет Auto Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API.
auth Boolean Нет False При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization.

Результат

Возвращает результат типа StringResult.

Имя свойства Тип Описание
Исходное XML JSON
Value value value String Строка, содержащая результат выполнения операции.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.

Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.

Исходное имя - это имя, которое используется непосредственно в коде API.


Ошибки

При возникновении ошибок, будет возвращаен результат типа ErrorResult.

В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом ImageToText.

Ключ Код Описание
AddressIsBlacklisted 1121 Ошибка происходит, когда в параметре URL указан адрес, который находится в чёрном списке.
ArgumentNullOrEmpty 2001 Ошибка происходит, если один из обязательных параметров не указан или имеет пустое значение.
ContentTypeNotFound 3102 Ошибка происходит, когда система не смогла обнаружить заголовок Content-Type при запросе по указанному URL.
InvalidContentType 3003 Ошибка возникает, когда тип содержимого (Content-Type) имеет неверное значение.
InvalidFileType 3002 Ошибка происходит, при попытке передать методу файл неправильного формата. Как правило, проверка типа файла осуществляется по данным заголовка Content-Type.

Ключ и код соответствуют элементам перчисления ErrorCode.

В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages. При этом, ответ сервера будет иметь тип StringResult.

Если метод содержит сообщения типа Critical, то можно считать, что работа метода завершена с ошибкой. Подобное поведение свойствено методам, в которых производится обработка списка данных, где каждый элемент списка является независимым от других элментов. Т.е. в таких случаях запрос может быть выполнен частично.


Примечания

Параметр chars используется только, если параметр type имеет значение Text.

Параметр color используется только, если параметр type имеет значение Html.

Незаивисимо от значения параметра size, изображение не будет меньше 10 и больше 500 пикслей.


Статистика


Конструктор запросов

type:
file:
url:
chars:
color:
size:

http:
lang:
auth:
cp: