Информационные запросы
<< Click to Display Table of Contents >> Интеллектуальные возможности > Сервисы Directum Ario > Описание API Ario > Отладка грамматик Информационные запросы |
Запрос |
Описание |
Запрос для отображения списка всех существующих грамматик |
|
Запрос для отображения списка активных грамматик |
|
Запрос для отображения списка закрытых (неактивных) грамматик |
|
Запрос для отображения основной информации о конкретной грамматике |
Синтаксис
GET {service_url}/api/factextractor/grammar
Пример запроса
GET http://smart:61100/api/factextractor/grammar
Ответ
Содержит список всех грамматик и основную информацию о них:
{
"results": [
{
"grammarId": 1,
"name": "Договоры",
"description": "Извлечение фактов договорных документов",
"grammarSetName": "Contract",
"isSystem": true,
"state": 1,
"factExtractorModelId": 6,
"factExtractorModel": {...},
"factExtractorModels": null
},
{},
...
]
}
Где:
•grammarId – ИД грамматики;
•name – наименование грамматики, соответствующее виду документов;
•description – описание грамматики;
•grammarSetName – наименование грамматики для обращения к API Smart Service в других HTTP-запросах;
•isSystem – признак того, что грамматика базовая. Возможные значения: true – устанавливается для всех грамматик из поставки, false – устанавливается для грамматик, созданных пользователем;
•state – статус грамматики. Возможные значения: 0 – неактивная (недействующая), 1 – активная (действующая);
•factExtractorModelId – ИД активной модели извлечения фактов;
•factExtractorModel – секция с информацией об активной модели извлечения фактов;
•factExtractorModels – другие модели извлечения фактов, обученные для грамматики. Параметры аналогичны переаметрам секции factExtractorModel. Принимает значение null, если нет созданных и обученных моделей извлечения фактов для грамматики.
Содержит основную информацию о модели извлечения фактов: "factExtractorModel": { •factExtractorModelId – ИД действующей модели извлечения фактов; •classes – секция с информацией о видах документов, входящих в модель; •isSystem – признак того, что грамматика базовая. Возможные значения: true – для грамматик из поставки, false – для грамматик, созданных пользователем; •tableFactExtractorModel – секция с информацией о модели для извлечения табличных фактов. Если в грамматике нет модели, принимает значение null; •description – описание грамматики; •created – дата и время публикации модели извлечения фактов; •metrics – секция с метриками модели извлечения фактов; •trainErrors – параметр с описанием ошибки. Если ошибок нет, указывается значение null. |
Содержит основную информацию о модели извлечения фактах из видов документов, входящих в модель: "tableFactExtractorModel": { •classifierModelId – ИД модели извлечения фактов; •classId – ИД вида документа; •displayName – наименование вида документа, которое видят пользователи прикладной системы; •name – внутреннее наименование вида документа; •metrics – секция с метриками вида документа. |
Содержит основную информацию о видах, входящих в модель: "tableFactExtractorModel": { •tableFactExtractorModelId – ИД модели извлечения фактов; •classes – секция с информацией о видах документов, входящих в модель; •created – дата и время публикации модели извлечения фактов; •metrics – секция с метриками модели извлечения фактов; •trainErrors – параметр с описанием ошибки. Если ошибок нет, указывается значение null. |
Содержит информацию о параметрах качества обученной модели извлечения факта: "metrics": { •metricsId – ИД записи о метриках в базе данных Directum Smart Service; •trainCount – количество документов, на котором обучена модель; •testCount – количество документов, которое при обучении откладывается на тестирование модели; •accuracy – правильность классификации. Отображает долю верно классифицированных документов. Метрика используется для анализа результатов обучения; •precision – точность извлечения фактов. Отображает долю фактов, которые модель извлекла верно. Метрика используется для анализа результатов обучения; •recall – полнота извлечения фактов. Отображает долю фактов, которые модель извлекла верно, по отношению к тем фактам, которые она пропустила. Метрика используется для анализа результатов обучения; •f1Measure – мера успешности обучения грамматики. Отображает гармоническое среднее между точностью (precision) и полнотой (recall) извлечения фактов. Метрика используется для анализа результатов обучения; •trainDuration – продолжительность обучения; •testDuration – продолжительность тестирования. |
Синтаксис
GET {service_url}/api/factextractor/grammar?state=1
Пример запроса
GET http://smart:61100/api/factextractor/grammar?state=1
Ответ
В ответе возвращается перечень всех активных грамматик с основной информацией о них. Параметры аналогичны параметрам ответа на запрос списка всех грамматик. Так как запрашивается список активных грамматик, в ответе параметр state всегда принимает значение 1.
Синтаксис
GET {service_url}/api/factextractor/grammar?state=0
Пример запроса
GET http://smart:61100/api/factextractor/grammar?state=0
Ответ
В ответе возвращается перечень всех неактивных грамматик с основной информацией о них. Параметры аналогичны параметрам ответа на запрос списка всех грамматик. Так как запрашивается список неактивных грамматик, в ответе параметр state всегда принимает значение 0.
Синтаксис
GET {service_url}/api/factextractor/grammar/{grammarSetname}
Пример запроса
GET http://smart:61100/api/factextractor/Letter
Ответ
В ответе возвращается основная информация о грамматике: ИД, ее наименование и описание, а также коллекция извлекаемых фактов и полей фактов. Параметры аналогичны параметрам ответа на запрос списка всех грамматик.
© Компания Directum, 2024 |