Настройка¶
Параметры системы задаются в файле конфигурации и переменных окружения. Значения, зависящие от площадки (адреса, пароли, ключи), берутся из переменных окружения и хранилища секретов, поэтому файл конфигурации одинаков для всех окружений.
Ниже описаны основные области настройки и рекомендации. Полный перечень переменных с значениями по умолчанию приведён в разделе Справочник параметров.
Что настраивается обязательно¶
| Область | Что задать |
|---|---|
| Языковая модель | Адрес сервиса, ключ доступа, название модели |
| Аналитическое хранилище | Адрес, порт, база, учётная запись |
| База метаданных | Строка подключения |
| Аутентификация | Адрес сервиса аутентификации, область, идентификатор клиента и секрет |
| Публикация | Доменное имя и сертификат для HTTPS |
Языковая модель¶
Поддерживаются сервисы с интерфейсом, совместимым с протоколом OpenAI, включая развёрнутые в контуре организации. Задаются адрес, ключ и название модели.
Для разных этапов работы можно назначить разные модели: составление плана, формирование запроса, подготовка ответа. Это позволяет использовать более лёгкую модель там, где не нужна максимальная точность.
Практические рекомендации:
- Тайм-аут обращения к модели выставляйте с запасом: длинные запросы к большим моделям идут дольше.
- При работе в закрытом контуре убедитесь, что обращения к внешним адресам не требуются.
Аналитическое хранилище¶
Помимо адреса и учётной записи настраиваются:
| Параметр | Смысл |
|---|---|
| Размер пула соединений | Сколько одновременных запросов может выполняться |
| Тайм-аут запроса | Через какое время запрос прерывается |
| Ограничение строк | Максимальное число строк в результате |
Ограничение строк защищает от выгрузки хранилища целиком одним вопросом. Значение подбирается под сценарии: слишком маленькое мешает работе, слишком большое нагружает систему и рабочие места.
Материализованные датасеты¶
Сохранённые результаты могут храниться в отдельной базе аналитического хранилища. Это ускоряет повторное открытие больших датасетов. Функция включается отдельно, база создаётся при первом использовании.
Доступ и безопасность¶
| Параметр | Рекомендация для промышленной эксплуатации |
|---|---|
| Требовать HTTPS для аутентификации | Включено |
| Роль по умолчанию | Не задавать. Пользователь без роли не должен получать доступ |
| Ограничение частоты запросов | Включить и подобрать лимит под профиль нагрузки |
| Интерактивная документация программного интерфейса | Отключить на публичном контуре |
Проверьте перед публикацией
В поставляемом файле конфигурации ограничение частоты запросов выключено. Это удобно при разворачивании стенда и недопустимо при публикации системы пользователям. Включите ограничение частоты до открытия доступа.
Журналирование¶
Настраиваются уровень подробности и формат записи. Для промышленной эксплуатации используется структурированный формат, он пригоден для автоматического разбора средствами сбора журналов.
Уровень подробности по умолчанию показывает ход обработки запросов без содержимого данных. Повышать подробность стоит только на время разбора проблемы.
Телеметрия¶
Система собирает сведения о своей работе: число запросов, время ответа, ошибки, обращения к языковой модели. Настраиваются:
- включение сбора;
- срок хранения записей;
- сохранение текстов запросов и ответов.
Тексты запросов
Сохранение текстов запросов и ответов по умолчанию выключено. Включайте осознанно: в текстах могут оказаться сведения ограниченного доступа. Просмотр таких записей закрывается отдельным правом.
Отчёты и домены данных¶
Расположение файлов доменов и шаблонов отчётов задаётся в конфигурации. Файлы подключаются без пересборки системы, изменения применяются перезапуском сервера Орбиты. Подробнее: Подключение данных.
Применение изменений¶
После правки конфигурации перезапустите сервер Орбиты:
Проверьте, что система поднялась: