Skip to content

AI проверка описания

AI проверка описания предназначена для проверки текстового описания датасета на соответствие внутренним требованиям и стандартам, существующим в организации. Она помогает владельцам данных быстро оценить качество описания и получить конкретные рекомендации по его улучшению, что экономит время на ручную проверку и правки.

Настройки, предварительные условия, разрешения

Для работы с результатами проверки применяются следующие привилегии

  • Для просмотра результатов проверки описания - View Description AI Recommendations
  • Для запуска проверки описания - Trigger Description AI Validation

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

Запуск проверки

Чтобы воспользоваться функцией:

  • На странице датасета перейдите на вкладку Documentation (Описание);
  • Нажмите на кнопку AI Recommendations (Рекомендации от ИИ);

Кнопка просмотра AI оценки
- В открывшемся модальном окне нажмите на кнопку Generate Recommendation (Сгенерировать рекомендацию);

Кнопка генерации оценки
- После сообщения об успешной генерации в модальном окне появятся результаты проверки.

После внесения каких-либо изменений в описание, проверку можно запустить еще раз для обновления оценки и рекомендаций.

Просмотр результатов проверки

Для просмотра результатов проверки необходимо на вкладке Documentation (Описание) страницы датасета нажать на кнопку AI Recommendations (Рекомендации от ИИ).

Результаты оценки

Структура результата проверки

Результат проверки описания состоит из следующих частей:
- Общая оценка описания. Измеряется в % (от 0 до 100) и отображается на вкладке Documentation (Описание) датасета, а также в модальном окне работы с результатами проверки. Представляет собой агрегированную оценку соответствия описания требованиям по всем проверяемым параметрам;
- Оценка описания. Короткие комментарии по каждому пункту, по которому происходила проверка;
- Рекомендации по улучшению. Советы, следуя которым можно улучшить качество описания.

Info

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

Inner Note

Структура описания таблицы:
1 раздел - название таблицы. Должно быть на русском языке. Название должно начинаться с прописной (большой) буквы. (Например, "Категории финансовой отчетности организаций", "Цели кредитования юридических лиц").
2 раздел - краткое описание таблицы. Содержит краткое описание назначения или содержания справочника (например, "Унифицированный справочник стран"). Описание должно быть на русском языке, состоять из одного или нескольких предложений.
3 раздел - примеры использования данных (например "может быть использован для управления программами лояльности, такими как начисление бонусов и кэшбека пользователям за определенные действия").
4 раздел - Процесс актуализации. Описание процесса обновления данных (например, "Прямой ввод данных в RDM").
5 раздел - Входящая и исходящая интеграция. Состоит из описания следующих разделов, но допускаются плейсхолдеры или информация о том, что интеграции отстутствуют:
Система (Исходная система) - название системы, откуда поступают данные
Кластеры системы - название кластера или группы (если применимо)
Таблицы целевой системы - название таблицы или базы, куда направляются данные и тип целевой системы - тип системы (например, CRM, ERP, база данных)
Частота передачи данных: режим - режим передачи (например, "реальное время", "пакетная обработка") и график - конкретное расписание (например, "ежедневно в 00:00")
Способ взаимодействия: интерфейс - используемый интерфейс (например, "REST API"), формат данных - формат передачи (например, "JSON"), протоколы - протоколы передачи (например, "HTTPS")
Инициатор соединения - кто инициирует соединение (например, "исходная система"), триггеры - условия запуска передачи (например, "по событию"), аутентификация и безопасность - методы аутентификации и защиты (например, "OAuth").
6 раздел - Глубина данных (например 3 года)