#API

#Структура запроса

Использование API предполагает отправку POST–запросов с набором JSON–параметров по адресу https://neuro-semantic.ru/[адрес запроса], где[адрес запроса]указывается в описании нужного запроса.

#Структура ответа

В качестве ответа на любой запрос по корректному адресу возвращается JSON–структура данных с ответом.

Структура ответа всегда однообразна и содержит следующие атрибуты:

#Алгоритм проведения расчета

Анализ текстов с помощью API выполняется в 2 шага:

1. создание запроса;
2. получение результатов запроса по идентификатору.

#Пользователь

#Информация о балансе

Возвращает остаток средств на балансе пользователя.

Адрес:/api/user/balance

Параметры:

Структура данных ответа в полеdata:

#История баланса

Возвращает историю списаний и пополнений баланса пользователя.

Адрес:/api/user/balance/history

Параметры:

Структура данных ответа в полеdata:

Структура объекта в массиве данных истории баланса пользователя:

#История запросов

Возвращает историю запросов к сервису.

Адрес:/api/history/get

Параметры:

Структура данных ответа в полеdata:

Структура объекта в массиве данных истории запросов пользователя:

#Расчет

#Получение результата

Получение данных о созданном ранее расчете.

Адрес:/api/transaction/get

Параметры:

Структура данных ответа в полеdata: объект сJSON–структурой данных о транзакции.

#Создание транзакции

Адрес:/api/transaction/create

В случае расчета ММК обязательным параметром при создании транзакции является тема по которой производится классификация. Тема должна быть передана в видеJSON–структуры. Подобное необходимо для сохранения возможности восстановить объект анализа в случае изменения или удаления темы.
Для получения JSON–структур всех тем пользователя можно воспользоваться запросомполучения списка тем.

Параметры:

Структура данных ответа в полеdata: объект сJSON–структурой данных о транзакции.

#Типы расчета

#Получение данных о типах запросов

Получение списка типов запросов со всеми вариантами их названий и стоимостями.

Адрес:/api/calc_types/get

Входные параметры отсутствуют.

Структура данных ответа в полеdataсодержитJSON–объект с данными о типах запросов.

#Сущности

#Обновление сущностей темы

Позволяет добавить, обновить или удалить сущности выбранной темы.

Адрес:/api/entities/update

Параметры:

Структура данных ответа в полеdataотсутствует.

#Темы

#Создание

Адрес:/api/themes/create

Параметры:

Структура данных ответа в полеdataсодержитJSON–объект с данными темы.

#Редактирование

Позволяет отредактировать название и описание темы, а также ее сущности.

Адрес:/api/themes/update

Параметры:

Структура данных ответа в полеdataотсутствует.

#Список

Возвращает список тем пользователя.

Адрес:/api/themes/get

Параметры:

Структура данных ответа в полеdataсодержит массивJSON–объектов с данными темы.

#Удаление

Адрес:/api/themes/delete

Параметры:

Структура данных ответа в полеdataотсутствует.

#Каталоги

#Создание

Адрес:/api/directory/create

Параметры:

Структура данных ответа в полеdataотсутствует.

#Редактирование

Позволяет изменить название каталога.

Адрес:/api/directory/update

Параметры:

Структура данных ответа в полеdataотсутствует.

#Список

Возвращает список каталогов и тем, содержащихся в каталоге.

Адрес:/api/directory/get

Параметры:

Структура данных ответа в полеdataсодержит массив JSON–объектов сданными каталоговиданными тем.

#Удаление

Адрес:/api/directory/delete

Параметры:

Структура данных ответа в полеdataотсутствует.

#JSON–структуры данных

#Результаты расчета

Представляет собойJSON–объект темы,объекты сущностейкоторой содержат дополнительные поля:

• texts— тексты, соотнесенные с сущностью;
• texts_amount— количество текстов, соотнесенных с сущностью;
• texts_percent— количество текстов, соотнесенных с сущностью, выраженное в процентах от общего количества текстов в расчете.

Кроме этого набор сущностей темы, по которой производился расчет, дополняется сущностьюНе распознано, которой сопоставляются все тексты, которые не удалось классифицировать. Объект сущностиНе распознанообладает теми же атрибутами, что и обычные сущности.

#Содержимое каталога

#Сущность

#Тема

#Тип запроса

#Транзакция

#Коды ошибок