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

PromptCreate

Промпт — это версионируемая LLM-инструкция, принадлежащая агенту. У каждого промпта есть тип (чат-бот "prompt", classification, document, ping, calendar, state, outreach, stage_triggered, redirect, clarification, custom_follow_up, formatting, playbook и другие — см. PromptType) и одна активная версия. Плейбук — это промпт типа "playbook": набор инструкций, который чат-бот подключает по ходу диалога вместо того, чтобы носить его в основном промпте.

textTextrequired

Начальный текст промпта (становится содержимым первой версии).

nameNamerequired

Человекочитаемое название промпта.

description object

Только для плейбуков: однострочное «когда использовать», которое чат-бот видит в каталоге плейбуков. Модель может подключить плейбук, только если это поле заполнено, — плейбук без описания ей не предлагается. Для остальных типов промптов игнорируется.

anyOf
string
config object

Настройки промпта (PromptConfig). Сейчас их читают только плейбуки: crm_fields_conditions заставляет платформу подключать плейбук автоматически для лидов, чьи CRM-поля подходят под условия, ещё до запуска модели. По умолчанию — пустая конфигурация.

crm_fields_conditions object

Составные условия по CRM-полям (та же структура, что у A/B-кампаний и рассылок: AND/OR с операторами для каждого поля). Если задано хотя бы одно условие, платформа подключает плейбук к диалогу, как только CRM-поля лида подходят под условия, — до запуска модели, без вызова инструмента. Пустой список условий никогда не подключает плейбук автоматически; null (по умолчанию) оставляет решение за моделью.

anyOf
operatorCRMFieldsConditionsOperator

Possible values: [AND, OR]

Default value: AND
conditions object[]
  • Array [
  • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
  • product_idProduct Idrequired

    Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

    agent_idAgent Idrequired

    Идентификатор агента (настроенного ИИ-ассистента/бота), которому принадлежит запись.

    author object

    Автор промпта.

    anyOf
    string
    typeTyperequired

    Назначение/тип промпта (см. PromptType). "playbook" — подключаемый по ходу диалога набор инструкций; см. description и config.

    Possible values: [prompt, classification, document, ping, calendar, state, outreach, stage_triggered, redirect, clarification, human_clarification_follow_up, custom_follow_up, formatting, playbook, qualification, disqualification, escalation]

    version_description object

    Необязательное описание создаваемой версии.

    anyOf
    string
    document_type object

    Для промптов типа "document" — к какому типу документа они применяются.

    anyOf
    string
    langLanguage

    Язык промпта.

    Possible values: [ru, en, pt, es]

    Default value: ru
    modalityModality

    Модальность диалога, которую обслуживает промпт — text (по умолчанию, чат-каналы) или voice (голосовой рантайм).

    Possible values: [text, voice]

    Default value: text
    skip_instructions object

    Для промптов пингов/напоминаний/триггеров этапа — инструкции на естественном языке о том, когда пропускать отправку.

    anyOf
    string
    acknowledged_checksstring[]

    Коды замечаний проверки промпта, которые клиент явно принимает («сохранить всё равно»). При создании и при обновлении текста содержимое промпта проверяется: сломанный Jinja-синтаксис, динамические части {{ ... }} выше маркера ---cache breakpoint--- (ломают кэширование промпта), маркер с опечаткой, ссылки на .md-файлы, а также переменные {{ ... }} внутри плейбука (тела плейбуков передаются модели как есть и не рендерятся). Нарушения отклоняются с HTTP 412, detail.code prompt_checks_failed и списком findings из {code, level, message}. Чтобы сохранить несмотря на замечания, повторите тот же запрос, указав коды из ответа в этом поле. Замечания уровня critical (сломанный Jinja) принять нельзя. Неизвестные коды игнорируются.

    PromptCreate
    {
    "text": "string",
    "name": "string",
    "description": "string",
    "config": {
    "crm_fields_conditions": {
    "operator": "AND",
    "conditions": [
    {
    "field": "string",
    "operator": "EQUALS"
    }
    ]
    }
    },
    "product_id": 0,
    "agent_id": 0,
    "author": "string",
    "type": "prompt",
    "version_description": "string",
    "document_type": "string",
    "lang": "ru",
    "modality": "text",
    "skip_instructions": "string",
    "acknowledged_checks": [
    "string"
    ]
    }