FullPrompt

prompt objectrequired

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

idIdrequired

Уникальный числовой идентификатор записи.

nameNamerequired

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

description object

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

anyOf

• string
• null

string

config object

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

crm_fields_conditions object

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

anyOf

• CRMFieldsConditionsConfig
• null

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

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

created_atdate-timerequired

Время создания (UTC, ISO 8601).

updated_atdate-timerequired

Время последнего изменения (UTC, ISO 8601).

author objectrequired

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

anyOf

• string
• null

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]

document_type objectrequired

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

anyOf

• string
• null

string

enabled_version_id objectrequired

Идентификатор версии промпта, используемой сейчас.

anyOf

• integer
• null

integer

skip_instructions objectrequired

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

anyOf

• string
• null

string

langLanguagerequired

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

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

modalityModalityrequired

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

Possible values: [text, voice]

version objectrequired

Отдельная сохранённая версия промпта.

idIdrequired

Уникальный числовой идентификатор записи.

prompt_idPrompt Idrequired

Идентификатор промпта, которому принадлежит версия.

version_numberVersion Numberrequired

Монотонно растущий номер версии внутри промпта.

contentContentrequired

Текст промпта для этой версии.

description objectrequired

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

anyOf

• string
• null

string

author objectrequired

Автор этой версии.

anyOf

• string
• null

string

created_atdate-timerequired

Время создания (UTC, ISO 8601).

FullPrompt

{
  "prompt": {
    "id": 0,
    "name": "string",
    "description": "string",
    "config": {
      "crm_fields_conditions": {
        "operator": "AND",
        "conditions": [
          {
            "field": "string",
            "operator": "EQUALS"
          }
        ]
      }
    },
    "product_id": 0,
    "agent_id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": "string",
    "type": "prompt",
    "document_type": "string",
    "enabled_version_id": 0,
    "skip_instructions": "string",
    "lang": "ru",
    "modality": "text"
  },
  "version": {
    "id": 0,
    "prompt_id": 0,
    "version_number": 0,
    "content": "string",
    "description": "string",
    "author": "string",
    "created_at": "2024-07-29T15:51:28.071Z"
  }
}