Информационные запросы о классификаторе
<< Click to Display Table of Contents >> Интеллектуальные возможности > Сервисы Directum Ario > Описание API Ario > Отладка классификатора Информационные запросы о классификаторе |
Запрос |
Описание |
Запрос для отображения основной информации о конкретном классификаторе |
|
Запрос для отображения списка существующих классификаторов |
Просмотр информации о классификаторе
Синтаксис
GET {service_url}/api/Classifiers/{ИД классификатора}
Пример запроса
GET http://smart:61100/api/Classifiers/1
Ответ
Содержит основную информацию о классификаторе, действующей модели и входящих в нее классах:
{
"publishedModelId": 2807,
"publishedModel": {...},
"classifierModels": [...],
"classifierId": 8,
"name": "Классификатор по виду документа",
"type": null,
"status": 1,
"created": "2018-09-17T16:41:38.312664",
"published": "2021-01-28T10:15:02.591548",
"autoPublish": true,
"minProbability": 0.75,
"useFixedForms": false
}
Где:
•publishedModelId – ИД действующей модели классификации;
•publishedModel – секция с информацией о действующей модели классификации;
•classifierModels – секция с информацией обо всех моделях классификации в классификаторе;
•classifierId – ИД классификатора;
•name – наименование классификатора;
•type – тип классификатора. Возможные значения: Kind – системный классификатор по видам документов, FirstPage – системный классификатор по первым страницам, null – классификатор, созданный пользователем;
•status – статус классификатора. Возможные значения: 0 – неактивный (недействующий), 1 – активный (действующий);
•created – дата и время создания классификатора;
•published – дата и время публикации классификатора;
•autoPublish – признак того, что модель автоматически публикуется в классификаторе и становится активной (действующей). Параметр принимает значение, установленное для классификатора при его создании. Возможные значения: true, false;
•minProbability – минимальная вероятность, при которой определяется класс документа. Параметр принимает значение, установленное для классификатора при его создании. Возможные значения: от 0 до 1;
•useFixedForms – признак того, что классификатор обрабатывает документы жесткой формы, например паспорта РФ. Возможные значения: true, false.
"publishedModel": { Содержит основную информацию о действующей модели классификации: •classifierModelId – ИД действующей модели классификации; •isSystem – признак того, что классификатор системный. Возможные значения: true – для классификаторов из поставки, false – для классификаторов, созданных пользователем; •classes – секция с информацией о классах, входящих в модель; •recommendedThreshold – значение, при котором мера успешности обучения классификатора на тестовой выборке максимальная. Это значение рекомендуется задавать в параметре minProbability при создании или изменении классификатора; •withDataset – признак того, что у модели есть набор данных для обучения. Его наличие определяет возможность дообучения модели классификации. Возможные значения: true – модель можно дообучать, false – модель дообучать нельзя; •created – дата и время публикации модели классификации; •metrics – секция с метриками модели классификации; •trainErrors – параметр с описанием ошибки при обучении. Если ошибки не возникали, указывается значение null. |
"classes": [ Содержит основную информацию о классах, входящих в модель: •classifierModelId – ИД действующей модели классификации; •externalId – внешний ИД класса для обучения данными в формате CSV; •isFixedForm – признак того, что форма документа жесткая. Возможные значения: true, null; •classId – ИД класса; •displayName – отображаемое наименование класса, которое видят пользователи прикладной системы; •name – внутреннее наименование класса; •metrics – секция с метриками класса. |
"metrics": { Содержит информацию о параметрах качества обученной модели классификации или класса: •metricsId – ИД записи о метриках в базе данных Directum Smart Service; •trainCount – количество документов, на котором обучена модель или класс; •testCount – количество документов, которое откладывается при обучении на тестирование модели или класса; •accuracy – точность классификации. Отображает долю верно классифицированных документов. Метрика используется для анализа результатов обучения; •precision – точность классификации. Отображает долю документов, которые отнесены классификатором к классу и действительно принадлежат ему. Метрика используется для анализа результатов обучения; •recall – полнота классификации. Отображает долю документов нужного класса, которые нашел классификатор, по отношению к тем документам, которые он ошибочно пропустил. Метрика используется для анализа результатов обучения; •f1Measure – мера успешности обучения классификатора. Отображает гармоническое среднее между точностью (precision) и полнотой (recall) классификации. Метрика используется для анализа результатов обучения; •trainDuration – продолжительность обучения; •testDuration – продолжительность тестирования. |
Содержит основную информацию обо всех моделях, обученных для классификатора. Параметры аналогичны параметрам секции publishedModel. |
Просмотр списка классификаторов
Синтаксис
GET {service_url}/api/Classifiers
Пример запроса
GET http://smart:61100/api/Classifiers
Ответ
Содержит перечень всех классификаторов с информацией о входящих в них моделях и классах. Параметры аналогичны параметрам ответа на запрос информации о конкретном классификаторе.
© Компания Directum, 2024 |