Перейти к содержимому

Override API

Для валидации входящих сообщений пользователя до их передачи в LLM, когда правила проверки необходимо задать прямо в запросе, а не через настройки Web UI.


Для валидации исходящих ответов LLM перед их возвратом конечному пользователю, с конфигурацией проверки непосредственно в запросе.

Override-эндпоинты позволяют задавать параметры валидации inline, игнорируя настройки Web UI.

Важно:

  • Настройки валидации из Web UI не применяются
  • Валидация полностью управляется через validation_config
  • Соответствующие сервисы (dataclean, guardrails, custom) должны быть включены на уровне развертывания

ПолеТипОписание
application_idstring (UUID)Идентификатор приложения. Должен существовать в HiveTrace.
messagestringСообщение пользователя или ответ LLM в зависимости от эндпоинта.
validation_configobjectInline-конфигурация валидации.

ПолеТипОписание
additional_parametersobjectМетаданные для отслеживания сессии и пользователя.

Определяет правила проверки непосредственно внутри запроса.

{
"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" }]
}
}
}
}

patterns — список паттернов модуля очистки персональных данных. Элемент списка может быть:

  • строкой с именем предопределённого паттерна
  • объектом с кастомным паттерном { "name": "...", "regex": "..." }

Разрешённые значения для предопределенных паттернов:

ПаттернОписание
ADDRESSАдрес
BANK_CARD_NUMBERНомер банковской карты
COMPANYКомпания / организация
CVCCVC/CVV код банковской карты
DATEДата
DEADLINE_DATEДата дедлайна / срок (дата)
DIAGNOSISДиагноз
DOMAINДомен
DURATIONДлительность / период
EMAILSEmail-адреса
INNИНН
IPIP-адрес
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.