Личный кабинет
Вернуться в Dashboard

Документация

На странице

Начало работы с AI-агентом

AI-оператор и Copilot работают поверх AI-агента — единой сущности, которая содержит контекст, системный промпт, набор товаров, базу знаний и API-интеграцию. AI-агент создаётся один раз в организации и затем выбирается на конкретном канале, в Copilot или в AI-ноде конструктора. Эта страница объясняет, что входит в AI-агента и зачем он нужен.

Что содержит AI-агент

Часть агентаЧто этоЗачем нужно
Контекст и промптОбщее описание компании/домена и системные инструкции для AIПодставляются в каждый запрос AI-оператора и Copilot
Набор товаровКаталог товаров — через ссылки или из CSVAI подбирает релевантные товары на вопрос клиента
База знанийТекстовые материалы (FAQ, политики, инструкции)AI использует для ответов на вопросы не про товар
API-интеграцияРучки вашего бэкенда, доступные AI-оператору во время диалогаAI вызывает ваш API (получение профиля, статус заказа, и т.п.)

Модель

PLAINTEXT
Организация
  ├─ AI-агенты
  │   └─ Агент
  │       ├─ Контекст и промпт
  │       ├─ Набор товаров
  │       ├─ База знаний
  │       └─ API-интеграция
  │
  └─ Каналы
      └─ Настройки AI-оператора: { aiAgentId }

AI-агент и канал — это разные сущности. Одного и того же агента можно выбрать на нескольких каналах. Канал хранит лишь ссылку на выбранного агента — все данные (товары, база знаний, контекст, API) физически принадлежат агенту, а не каналу.

Где что настраивается в UI

  • Настройки → AI-агенты — создание и редактирование агентов: внутри агента задаются контекст и промпт, набор товаров (с ссылками или без), база знаний и API-интеграция.
  • Настройки → Каналы → (конкретный канал) → AI-оператор — включение AI-оператора для канала и выбор одного AI-агента.

Типичный сценарий через API

  1. Выпустите API-токен с нужными scope-ами в Настройках → API токены.
  2. Создайте AI-агента через POST /api/v1/ai-agents/external/agents (задаёте name, context, prompt).
  3. Создайте набор товаров / базу знаний / интеграцию и привяжите их к агенту полем agentId.
  4. Получите channelId через GET /api/v1/external/channels.
  5. Укажите агента на канале через PATCH /api/v1/external/channels/{channelId}/ai-operator.
  6. Включите AI-оператора (status: true).
  7. Заполняйте товары / файлы / ручки агента через API — изменения подхватятся без перенастройки канала.

Контракт ответа

Успешные AI Agents и Channels запросы возвращают envelope { "status": "OK", "data": ... }. Ошибка содержит только числовой HTTP status, message, timestamp, path и опциональные code/details. Произвольные внутренние поля исключения в публичный ответ не попадают, а ломающие изменения выпускаются только в новой URI-версии.

Разделы документации

Подписка

Работа AI-оператора требует активной подписки на соответствующий тариф в Настройки → Оплата → AI-оператор. Без подписки status канала остаётся false даже при вызове PATCH.