Override API
Override-эндпоинты
Заголовок раздела «Override-эндпоинты»POST /process_request/override/
Заголовок раздела «POST /process_request/override/»Для валидации входящих сообщений пользователя до их передачи в LLM, когда правила проверки необходимо задать прямо в запросе, а не через настройки Web UI.
POST /process_response/override/
Заголовок раздела «POST /process_response/override/»Для валидации исходящих ответов LLM перед их возвратом конечному пользователю, с конфигурацией проверки непосредственно в запросе.
Override-эндпоинты позволяют задавать параметры валидации inline, игнорируя настройки Web UI.
Важно:
- Настройки валидации из Web UI не применяются
- Валидация полностью управляется через
validation_config - Соответствующие сервисы (dataclean, guardrails, custom) должны быть включены на уровне развертывания
Тело запроса
Заголовок раздела «Тело запроса»Обязательные поля
Заголовок раздела «Обязательные поля»| Поле | Тип | Описание |
|---|---|---|
application_id | string (UUID) | Идентификатор приложения. Должен существовать в HiveTrace. |
message | string | Сообщение пользователя или ответ LLM в зависимости от эндпоинта. |
validation_config | object | Inline-конфигурация валидации. |
Опциональные поля
Заголовок раздела «Опциональные поля»| Поле | Тип | Описание |
|---|---|---|
additional_parameters | object | Метаданные для отслеживания сессии и пользователя. |
Inline-валидация (validation_config)
Заголовок раздела «Inline-валидация (validation_config)»Определяет правила проверки непосредственно внутри запроса.
{ "application_id": "{{application_id}}", "message": "My name is John, my CVC is 222, and I own a car.", "additional_parameters": { "session_id": "{{client_session_id}}", "user_id": "{{client_user_id}}" }, "validation_config": { "source": "inline", "inline": { "guardrails": { "enabled": true }, "custom": { "enabled": true, "policies": [ { "name": "medicine", "prompt": "Do not provide medical advice or discuss medical topics." } ] }, "dataclean": { "enabled": true, "clean_type": "masking", "patterns": ["CVC", { "name": "AUTOMOBILE", "regex": "\\bcar\\b" }] } } }}dataclean.patterns: разрешенные значения
Заголовок раздела «dataclean.patterns: разрешенные значения»patterns — список паттернов модуля очистки персональных данных. Элемент списка может быть:
- строкой с именем предопределённого паттерна
- объектом с кастомным паттерном
{ "name": "...", "regex": "..." }
Разрешённые значения для предопределенных паттернов:
| Паттерн | Описание |
|---|---|
ADDRESS | Адрес |
BANK_CARD_NUMBER | Номер банковской карты |
COMPANY | Компания / организация |
CVC | CVC/CVV код банковской карты |
DATE | Дата |
DEADLINE_DATE | Дата дедлайна / срок (дата) |
DIAGNOSIS | Диагноз |
DOMAIN | Домен |
DURATION | Длительность / период |
EMAILS | Email-адреса |
INN | ИНН |
IP | IP-адрес |
JOB_ROLE | Должность / роль |
KPP | КПП |
MONEY | Денежные суммы |
NAME | Имя (ФИО) |
OGRN | ОГРН |
OGRNIP | ОГРНИП |
PASSPORT_NUMBER | Номер паспорта |
PHONE_NUMBER | Номер телефона |
SNILS | СНИЛС |
dataclean.clean_type (masking type): разрешённые значения
Заголовок раздела «dataclean.clean_type (masking type): разрешённые значения»| Masking type | Описание |
|---|---|
MASKING | Маскирование: заменяет найденные значения маской |
DELETION | Удаление: удаляет найденные значения из текста |
DETECTION | Детекция: только обнаруживает совпадения, без изменения текста |
Схема ответа
Заголовок раздела «Схема ответа»Override-эндпоинты возвращают ту же структуру ответа, что и Base API.