Работа с модулем среды разработки

Описание интерфейса

Интерфейс среды разработки реализован в виде веб-приложения и содержит следующие элементы:

• Левая панель инструментов:

  • Консоль — выполнение Ad-hoc запросов.

  • Поиск — форма поиска по различным объектам.

  • Расписание — список блокнотов, запланированных на запуск по расписанию.

  • ИИ агент — окно работы с искусственным интеллектом.

  • Язык — выбор языка интерфейса.

  • Настройки — конфигурация параметров и выход из системы.

• Правая панель инструментов:

  • Блокноты — создание и управление блокнотами.

  • Таблицы — просмотр объектов, доступных в хранилище данных.

  • Сниппеты — создание и сохранение пользовательских фрагментов кода.

  • Вып. запросы — история выполненных запросов и их результаты.

• Центральная область:

  • Область редактора — ввод и редактирование запросов.

  • Область результатов — отображение результатов выполнения запросов в табличной форме.

Вход в систему

Процесс аутентификации пользователя в веб-интерфейсе подсистемы:

1. Откройте указанный URL-адрес в браузере.

2. Нажмите кнопку «Login».

3. Введите логин и пароль.

4. Нажмите кнопку «Sign In».

Смена языка интерфейса

Изменение языка отображения элементов интерфейса:

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «Язык».

3. Выберите Русский или English.

Выход из системы

Завершение сеанса работы пользователя:

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «Настройки».

3. Нажмите кнопку «Выход».

Интерфейс работы с запросами

Интерфейс состоит из следующих элементов:

• Область редактирования — ввод SQL-запросов или текстовых инструкций для ИИ.

• Область результатов — отображение данных, полученных в результате выполнения запроса.

• Дополнительные действия :

  • Форматировать — переформатирование запроса в удобный для чтения вид.

  • Скрыть запрос — удаление текста запроса из области редактирования.

  • Выполнение — запуск выполнения запроса.

В области результатов доступны:

1. Скрыть колонки — фильтрация отображения колонок результирующей таблицы.

2. Full Screen — разворачивание результирующей таблицы на весь экран.

3. Просмотр результатов нескольких запросов — переключение между результатами через выпадающее меню кнопки Запрос 1 из N.

Выполнение Ad-hoc запросов

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «Консоль».

3. В панели редактора введите необходимый SQL-запрос в поле запроса.

4. Нажмите кнопку «Выполнить».

5. В области результатов отобразится результирующая таблица.

Выполнение Ad-hoc запросов с помощью AI

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «Консоль».

3. В панели редактора введите текстовый запрос в поле работы с AI.

4. Нажмите Enter.

5. Подтвердите правильность созданного запроса, нажав Разрешить.

6. Нажмите Выполнить.

7. В области результатов отобразится результирующая таблица.

Выполнение поиска

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «Поиск» .

3. В открывшемся окне выберите тип объекта: запрос, блокнот, таблицы, список.

4. Введите интересующую информацию в поле поиска.

5. При необходимости используйте фильтры в правой части окна для уточнения поиска.

Просмотр состава таблиц

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Таблицы» .

3. В открывшейся оснастке разверните каталог.

4. Разверните необходимую базу данных.

5. Нажмите на нужную таблицу.

6. Нажмите «Посмотреть таблицу».

7. В открывшейся оснастке переключайтесь по вкладкам «Обзор», «Колонки», «Примеры строк», «Исходный запрос», «Предупреждения», — для просмотра информации.

8. Для работы с таблицей доступны действия:

   • Добавить в избранное — нажмите кнопку «Добавить в избранное».

   • Добавить теги — нажмите .

   • Добавить себя как владельца — нажмите напротив поля «Владельцы».

   • Редактировать описание — нажмите «Редактировать», введите текст и нажмите «Сохранить».

   • Добавить в список — нажмите и выберите нужный.

Просмотр и поиск сниппетов

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Сниппеты» .

3. В открывшейся оснастке выберите:

   • Публичный — доступен всем пользователям.

   • Приватный — доступен только вам.

4. Для поиска введите имя сниппета в поле поиска.

Создание сниппетов

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Сниппеты».

3. В открывшейся оснастке нажмите кнопку .

4. Введите название, описание, запрос, выберите область видимости (Приватный или Публичный).

5. Нажмите «Сохранить».

Изменение сниппетов

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Сниппеты».

3. В открывшейся оснастке выберите сниппет.

4. Внесите изменения в запрос или описание.

5. Нажмите «Обновить».

Удаление сниппетов

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Сниппеты».

3. В открывшейся оснастке выберите сниппет.

4. Нажмите «Удалить».

Просмотр блокнотов

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Блокноты» .

3. В открывшейся оснастке разверните группированные списки:

   • Недавние — последние открытые блокноты.

   • Избранное — блокноты, добавленные в избранное.

   • Списки — пользовательские или общие списки блокнотов.

   • Мои блокноты — блокноты, созданные пользователем.

4. Выберите необходимый блокнот.

Создание блокнота

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Блокноты».

3. В открывшейся оснастке нажмите кнопку .

4. Выберите команду «Создать блокнот».

5. Введите название блокнота.

Создание блокнота с помощью AI

1. Войдите в подсистему среды разработки.

2. В правой панели инструментов нажмите кнопку «Блокноты».

3. В открывшейся оснастке нажмите кнопку .

4. Выберите команду «Создать блокнот с помощью AI».

5. Выберите каталог.

6. Выберите базу данных.

7. Введите текстовый запрос.

8. Нажмите «Создать».

Типы блоков в блокноте

В блокнотах поддерживается использование трёх типов блоков.

Текстовый блок

1. Нажмите кнопку «Текст» .

2. Введите текстовое описание.

Блок SQL-запроса

1. Нажмите кнопку «Запрос» .

2. Введите название запроса.

3. В блок редактирования введите SQL-запрос.

Использование AI при работе с запросами:

4. В поле работы с AI введите текстовый запрос.

5. Нажмите Enter.

6. Проверьте корректность сгенерированного SQL-запроса.

7. Нажмите «Разрешить».

8. При необходимости измените текстовый запрос и повторно подтвердите.

Выполнение запроса:

9. Нажмите кнопку «Выполнить» .

Дополнительные действия через меню запроса:

• Форматировать запрос — привести к читаемому виду.

• Объяснить запрос — получить описание запроса с помощью AI.

• Скрыть запрос — оставить только результаты.

• Отобразить шаблон — применить шаблон.

Блок диаграммы

1. Нажмите кнопку «Диаграмма» .

2. Если диаграмма создаётся сразу после запроса, он будет выбран источником данных по умолчанию.

3. Для изменения источника нажмите «Настройки диаграммы» ( → вкладка «Данные»).

4. Выберите:

   • Текущий запрос в блокноте.

   • Запрос в блокноте (с указанием номера).

   • Из выполненного запроса (с указанием названия и номера).

5. Настройте отображение во вкладках «Диаграмма» и «Визуализация».

6. Нажмите «Сохранить».

Управление блоками

1. Удалить блок — нажмите кнопку «Удалить» .

2. Комментарий — нажмите кнопку «Комментарий» , введите текст и нажмите «Comment».

Добавление переменной в блокноте

1. Нажмите + Новая переменная.

2. Укажите имя, тип и значение.

3. Сохраните изменения.

Дополнительные возможности

1. Запустить все — выполнение всех блоков в блокноте.

2. Добавить в избранное — значок звёздочки.

3. Доступ — выбрать Приватный или Публичный режим, при приватном можно назначить других пользователей.

4. Меню дополнительных действий :

   • Клонировать — копия блокнота.

   • Экспортировать в PDF — сохранить в файл PDF.

   • Списки — просмотр списка, в котором используется блокнот.

   • Шаблон — сохранить или применить шаблон.

   • Планировщик — задать расписание выполнения.

   • Удалить — удалить блокнот.

Работа с ИИ-агентом

ИИ-агент предоставляет возможность интерактивного взаимодействия с моделью LLM через интеграцию по протоколу MCP. Подсистема позволяет формировать запросы на естественном языке, получать автоматически сгенерированные SQL-запросы, выполнять их и просматривать результаты.

Интерфейс работы с ИИ-агентом

Экран работы с ИИ-агентом состоит из следующих элементов:

• Область ввода запроса — текстовое поле для ввода вопроса или задачи.

• Кнопка «Выполнить» — отправка запроса ИИ-агенту.

• Левая область — чат с ИИ-агентом (история запросов и ответов).

• Правая область — результаты выполнения запросов (таблицы, графики, текстовые описания).

• Кнопка «История» — просмотр предыдущих диалогов с ИИ-агентом.

• Кнопка «Новый чат» — очистка текущей истории и начало нового диалога.

Выполнение запроса через ИИ-агента

1. Войдите в подсистему среды разработки.

2. В левой панели инструментов нажмите кнопку «ИИ-агент» .

3. В приветственном окне в области ввода запроса введите вопрос или задачу на естественном языке.

4. Нажмите кнопку «Выполнить».

5. Дождитесь появления ответа в левой области чата.

6. Если ИИ-агент сгенерировал SQL-запрос:

   • Проверьте корректность предложенного запроса.

   • При необходимости, внесите изменения.

   • Подтвердите выполнение.

7. Результаты выполнения запроса будут отображены в правой области экрана.

Начало нового чата

1. В интерфейсе ИИ-агента нажмите кнопку «Новый чат» .

2. Текущая история общения будет очищена.

3. Введите новый запрос в область ввода и нажмите «Выполнить».

Работа с историей общения

1. В интерфейсе ИИ-агента нажмите кнопку «История» .

2. В открывшемся списке выберите интересующий диалог.

3. Просмотрите предыдущие запросы и ответы.