Разделы обучения бота
Разделы соответствуют настройкам обучения в приложении Helpfy AI. Используйте идентификатор одного и того же бота при настройке его знаний и поведения.
Модель поведения
Задаёт роль, стиль общения, постоянный контекст, приветствие и условия передачи оператору.
| Задача | Метод |
|---|---|
| Создать модель поведения | POST /bot-agents |
| Получить модели бота | GET /bot-agents |
| Изменить правила общения | PATCH /bot-agents/uniqueId |
Укажите bot_unique_id, задайте текст system_behavior и включите system_behavior_is_enabled. Для постоянных сведений используйте constant_context и соответствующий переключатель. После сохранения проверьте ответ в режиме SUPPORT.
Словарь
Помогает распознавать сокращения и специальные термины компании.
| Задача | Метод |
|---|---|
| Добавить термин | POST /glossary |
| Получить словарь | GET /glossary |
| Изменить определение | PATCH /glossary/uniqueId |
Добавляйте короткое и однозначное определение. Полные инструкции храните в базе знаний.
Функции
Позволяют боту получать данные и выполнять действия во внешней системе, например запрашивать статус заказа.
| Задача | Метод |
|---|---|
| Создать HTTP-функцию | POST /bot-tools |
| Получить функции бота | GET /bot-tools |
| Проверить запрос | POST /bot-tools/test |
| Изменить функцию | PATCH /bot-tools/uniqueId |
Укажите понятное описание назначения, схему аргументов input_schema_json, адрес и метод внешнего API. Сначала проверьте функцию с тестовыми аргументами. Проверка выполняет реальный запрос к внешнему сервису: для действий, меняющих данные, используйте тестовое окружение.
Включите функцию через is_enabled и вызовы функций у бота через tools_enabled. Результаты и ошибки доступны в журнале вызовов функций.
Сценарии
Описывают цепочку вопросов, ответов, проверок и вызовов функций.
| Задача | Метод |
|---|---|
| Получить правила и типы блоков | GET /bots/uniqueId/scenarios/authoring-kit |
| Создать сценарий | POST /bots/uniqueId/scenarios |
| Проверить выполнение | POST /bots/uniqueId/scenarios/scenarioUniqueId/test |
| Сохранить версию | POST /bots/uniqueId/scenarios/scenarioUniqueId/versions |
| Опубликовать версию | POST /bots/uniqueId/scenarios/scenarioUniqueId/versions/versionUniqueId/publish |
| Включить сценарий | PATCH /bots/uniqueId/scenarios/scenarioUniqueId/active |
Задайте trigger_description, примеры подходящих обращений и исключения. Получите допустимые блоки и ограничения через authoring-kit и limits, затем передайте схему в definition.
Сохранение версии и публикация — разные действия. Рабочая версия меняется после публикации. Проверьте все ветки, включая ошибку функции и перевод оператору. Обоснование выбора сценария смотрите в журнале использования сценариев.
Первая линия
Хранит готовые ответы на типовые вопросы до подключения основной модели.
| Задача | Метод |
|---|---|
| Добавить вопрос и ответ | POST /first-lines |
| Посмотреть готовые ответы | GET /first-lines |
| Обновить запись | PATCH /first-lines/uniqueId |
Добавьте основной вопрос, варианты формулировок и точный ответ. Для изменяющихся данных используйте функцию вместо статического текста.
Обучение бота: база знаний
Содержит документы, по которым бот ищет сведения для ответа.
| Задача | Метод |
|---|---|
| Создать группу | POST /knowledge-groups |
| Добавить документ | POST /knowledges |
| Загрузить PDF | POST /knowledges/upload |
| Импортировать сайт | POST /website-sources |
| Перенести знания другого бота | POST /knowledge-transfer/transfer |
| Проверить целостность | POST /knowledge-integrity/bots/botUniqueId/scan |
| Найти похожие документы | POST /knowledge-integrity/semantic-duplicates/scan |
Индексация определяет участие документа в поиске. Приватность источника скрывает ссылку, но не запрещает использовать содержимое. После импорта дождитесь обработки, затем проверьте вопрос по документу. Пошаговый пример базы знаний.