Системные контекстные переменные

Системная контекстная переменная — переменные, создаваемые в Чате Платформа для служебных целей и обеспечения работы Сценарий агента. Системная контекстная переменная недоступны для редактирования пользователем, но доступны для просмотра и использовании в Сценарий агента.В данной таблице перечислены все Системная контекстная переменная Платформа и их характеристики.

Переменная	Смысл	Скрыта от пользователя	Использование	Переменная всегда в контексте	Переменная всегда не пустая	Формат	Пример	Создание в Контексте Чата	Источник данных при создании	Изменение системой после создания	Изменение пользователем через слоты
agent_id	Уникальный идентификатор Агента в Платформа	нет	идентификация текущего агента в данном чате	да	да	число	1772	При создании Чата	Параметры Агента	Невозможно	Невозможно
chat_id	Уникальный идентификатор Чата в Платформа	нет	Идентификация Чата в Платформа Идентификация Чата во Входящий запрос	да	да	40 символов: латинские буквы и цифры	1fab819e20c1e939ed14d7024d17653fb07a77dd	При создании Чата	генерация по формуле chat_id={channel_name}:{channel_chat_id}гдеchannel_name = {token}:{connector_id}:{agent_id} переменная закодирована после генерации	Невозможно	Невозможно
channel_chat_id	идентификатор Собеседника в Конечный канал - синтетическая переменная, правила ее формирования задаются в настройках Коннектора к данному каналу	нет	Идентификация Чата и\или Собеседника в Конечный канал Генерация chat_id	да	да	<id чата\собеседника>|<название коннектора>	192929922|telegram	При создании Чат в платформе	генерация по формулесhannel_chat_id = {id_from_channel|connector_name}гдеid_from_channel - идентификатор чата\собеседника\визитера из Конечный каналconnector_name - название Коннектор для Конечный канал, в котором происходит Общение	Невозможно	Невозможно
channel_id	Уникальный идентификатор объекта платформы Канал Проекта.	нет	Уникальный идентификатор объекта платформы Канал Проекта в котором происходит общение в данном Чате	да	да	число	28844	При создании Чата в платформе	параметры Конечный канал Агента	Невозможно	Невозможно
client_message	Текст последнего сообщения, которое пришло от Собеседник в Чат	нет	движение бота по Сценарий агента в Сценарий агента по желанию дизайнера в слоте NLU, как объект для распознавания в слоте Regular Expression, как объект для проверки на соответствие регулярному выражению	да	нет	текст, формируется в конечном канале	Привет!	При поступлении первого сообщения от Собеседника в Чате	Конечный канал	сообщение собеседника в конечном канале команда start в телеграм боте техническое сообщение от конечного канала в зависимости от коннектора	Возможно
date	Время получения последнего сообщения от Собеседник = время получения последнего значения client_message, но именно из Канал Проекта (а не в слоте Memory)	нет	в Сценарий агента по желанию ДД в целях исполнения Сценарий агента	да	да	дата часовой пояс(UTC)	2020-12-17 13:29:19	При создании Чат в платформе	Время получения последнего сообщения	При получении нового сообщения от Собеседник	Невозможно
dialog_id	Идентификатор диалога	нет	в системных целях Идентификация нового диалога	да	да	строка	1fab819e20c1e939ed14d7024d17653fb07a77dd	При создании Чата в платформе	рандомайзер+хэш	При старте нового Диалога в Чате	Невозможно
modified_at	Время последней модификации Контекст Чата	нет	в Сценарий агента по желанию ДД	да	да	дата часовой пояс(UTC)	12/17/2020 10:46:25	При создании Чата в платформе	Время создания Чата	При изменении Контекст Чата	Невозможно
slot_id	Уникальный для платформы идентификатор последнего "выполненного" Слота в Сценарий агента	нет	в Сценарий агента по желанию ДД	да	да	число	1	При создании Чата в платформе	Начальная позиция в Сценарий агента - 1	При переходе к ноде соответствующей следующему Слот	Невозможно
strategy_modified_at	Время создания Обученная модель агента (время последнего переобучения)	нет	в Сценарий агента по желанию ДД, также используется для сброса состояния Чата при переобучении	да	да	дата	12/17/2020 10:46:25	При создании Чата в платформе	База данных платформы: обученная модель Сценарий агента Агента	При последующем сообщении от Собеседника после Обучение/переобучения	Невозможно
confidence	Процент уверенности модели NLU при распознавании Реплика Интентом	нет	при переходе по Сценарий агента после слота NLU	Нет	Да, когда присутствует в контексте	Число с плавающей точкой	0.4812345	При прохождении слота NLU	Результат работы NLU	При прохождении слота NLU. Если при следующем прохождении NLU Интент не распознается, то переменная будет удалена из Контекст Чата	Невозможно
error	Текст ошибки, полученный в результате выполнения слотов NLU/ Regular Expression / Memory	нет	при переходе по Сценарий агента после СлотовNLU/ Regular Expression / Memory	Нет	Да, когда присутствует в контексте	Строка	no intent!	При прохождении Слотов NLU/ Regular Expression / Memory	Результат выполнения операций NLU/ Regular Expression / Memory	При прохождении Слотов NLU/ Regular Expression / Memory	Невозможно
incoming_request_id	Уникальный для платформы идентификатор (токен) Входящий запрос	нет	испольуется для инициализации прохождения по Ветка сценария слота Incoming Request	Нет	Да, когда присутствует в контексте	Строка	5944::80nyRRRjWAjQGfHkQJyJu6VWT8ToMpw79wi3m4e-x0g	Записывается в контекст в момент получения запроса на исполнение слота Incoming Request	Данные сценания - слота IR	Удаляется после прохождения слота Incoming Request — переменная будет удалена из Контекст Чата после достижения следующего после слота Incoming Request слотов Wait For Reaction / Change Chat Mode	Невозможно
intent	Уникальный для платформы идентификатор распознанного Интента	нет	при переходе по Сценарий агента после слота NLU	Нет	Да, когда присутствует в контексте	Число	1	При прохождении слота NLU	Результат работы NLU	При прохождении слота NLU. Если при следующем прохождении слота NLU intent не распознается, то переменная будет удалена из Контекст Чата	Невозможно
request_success	Флаг, показывает успех последнего выполненного Внешний запрос в Сценарий агента	нет	в Сценарий агента по желанию ДД	нет	Да, когда присутствует в контексте	строка	True или False	При получении ответа на Внешний запрос	Результат выполнения слота External Request	При получении ответа на Внешний запрос . False - любые ошибки в процессе подготовки или обработки запроса, в т.ч. ответы с сервера с кодами 4хх и 5хх	Возможно
response_status_code	Код ответа сервера на выполненный Внешний запрос	нет	в Сценарий агента по желанию ДД	нет	Да, когда присутствует в контексте	число	от 100 до 599	При получении ответа на Внешний запрос	Результат выполнения слота External Request	При получении ответа на External Request	Возможно
parse_result	Строка - часть client_message, соответствующую регулярному выражению в слоте Regular Expression, полученная после успешной проверки client_message в данном слоте	нет	в Сценарий агента по желанию ДД	нет	Да, когда присутствует в контексте	строка	слово	При прохождении слота Regular Expression	Результат выполнения слота Regular Expression	При прохождении слота Regular Expression	Возможно
IR_url	Адрес активного вебхука Входящий запрос (слот Incoming Request) в данной Обученная модель агента	нет	Для отправки запроса из внешних систем Агенту	нет	Да, когда присутствует в контексте	url	https://admin.chatme.ai/api/incoming_request/29614::XnLlRoKPAnwLKNoFHUWPmzYkE1fT9pi-10ZkjcmDRBc	При прохождении слота Incoming Request	Данные поля WEBHOOK слота Incoming Request	Невозможно	Невозможно
node_id
savepoint_node_id	Идентификатор последнего достигнутого в Общение Слота с установленной точкой сохранения	нет	в Слоте Jump для перехода в соответствующий Слот через опцию “get slot id from context”	нет	да	число	1	При прохождении слота с установленной Точка сохранения - содержащего /s в поле Name	Обученная модель агента	Каждый раз прохождении слота с установленной Точка сохранения - содержащего /s в поле Name	Возможно
raw_response	Переменная содержит ответ внешней системы на Внешний запрос	нет	Для дебага Агента; для редактирования External Request (узнать, что приходит в ответ и что можно парсить)	нет	нет	строка	Успешный запрос: {"success":true,"temperature":"-5.3","feels_like":"-12.18"} Неуспешный запрос: {"success":false,"message":"empty city provided"}	При прохождении слота External Request	Внешняя система, к которой обращается External Request	Каждый раз при следующем прохождении этого же или другого слота External Request	Возможно
response_headers	Содержимое переменной: массив заголовков и их значений из полученного ответа на Внешний запрос и системная информация.	нет	в Сценарий агента по желанию ДД	нет	нет	строка	Успешный запрос:{'Server': 'nginx/1.14.0 (Ubuntu)', 'Date': 'Thu, 28 Apr 2022 12:09:42 GMT', 'Content-Type': 'application/json', 'Content-Length': '59', 'Connection': 'keep-alive'}При неуспешном запросе: если запрос дошёл до сервера, то заголовки формируются, если нет, то переменная чистится	При прохождении слота External Request	Внешняя система, которая отвечает на External Request	Каждый раз при следующем прохождении этого же или другого слота External Request	Возможно
notification_count	Счетчик рассылок в конкретном Чате	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	число	123	При прохождении слота Notification	Генерируется системой	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_task_id	Принимает значение равное Идентификатор задачи на рассылку,который система отправила в ответе (response) на Запрос на рассылку от внешней системе	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	строка (UUID)	123e4567-e89b-12d3-a456-426655440000	При прохождении слота Notification	Конечный канал, к которому обращается Notification	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_init_time	Датавремя начала выполнения Слота Notification по UTC	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	датавремя		При прохождении слота Notification	Генерируется системой	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_message_id	Когда рассылка отправляется, Конечный канал возвращает id сообщения	нет	движение Агента по Сценарий агента	Нет	Да, когда присутствует в контексте	строка	любая строка в зависимости от мессенджера	При прохождении слота Notification	Конечный канал, к которому обращается Notification	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_id	id рассылки, на данный момент = id Слота Notification	нет	движение Агента по Сценарий агента	Нет	Да, когда присутствует в контексте	число	123	При прохождении слота Notification	Данные сценария	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_raw_status	json-объект, запрос, который отправляет Конечный канал в ответ на рассылку, описание статуса	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	json-объект	{‘description’:’failed to build request’}{‘description’:’no account on <номер телефона\ключевой идентификатор собеседника>’, ‘channel_response’: тело ответа от канала as is (объект) }	При прохождении слота Notification	часть ‘description’ создается платформой, часть ‘channel_response’— Конечный канал, к которому обращается Notification	Каждый раз при следующем прохождении этого же или другого слота Notification	Возможно
notification_status	Технический статус рассылкиВозможные значения: ‘no_account’, ‘failed’, ‘sent’, ‘delivered’, ‘read’	нет	движение Агента по Сценарий агента	Нет	Да, когда присутствует в контексте	строка	'sent''delivered'‘failed’‘no_account’.	При прохождении слота Notification	Конечный канал, к которому обращается Notification	Каждый раз при следующем прохождении этого же или другого слота Notification	Невозможно
notification_raw_request	Запрос, который Платформа отправляет в мессенджер для запуска рассылки	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	json-объект	{ "to": "9601103070", "type": "template", "template": { "namespace": "2a958ec8_9602_4cc0_aea4_73006715d273", "name": "mailing_02", "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "\u044d\u043d\u0434\u043e\u043a\u0440\u0438\u043d\u043e\u043b\u043e\u0433" } }	При прохождении слота Notification	Генерируется Слотом Notification	Каждый раз при следующем прохождении этого же или другого слота Notification	Возможно
intent_name	В переменной хранится название последнего пройденного интента	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	строка	smalltalk_hello	При прохождении подслота intent	берется из поля Name ИнтентаВажно: Если название Интента было изменено в Ресурс компании и Агент был переобучен, то в переменную записывается то название, которое было актуально на момент прохождения слота с этим Интентом. Если название Интента было изменено в Ресурс компании, но Агент не был переобучен, то в переменную записывается старое название Интента.	каждый раз при прохождении этого же или другого подслота intent	Возможно
nlu_result	В переменной хранится информация о топ-5 распознанных интентов в порядке убывания конфиденса	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	json-объект;может содержать разное количество пар ключ-значение: 5 пар — если Слот NLU имеет 5 или более Подслотов intent; 2-4 пары — если Слот NLU имеет от 2 до 4 Подслотов intent (количество пар будет соответствовать количеству Подслотов intent); 1 пару — если Реплика Собеседника является точным совпадением Обучающая фраза одного из Интентов	[{'intent_name': 'size', 'confidence': 0.9993743300437927}, {'intent_name': 'product_in_stock', 'confidence': 0.00019508253899402916}, {'intent_name': 'model_price', 'confidence': 0.00012844608863815665}, {'intent_name': 'address', 'confidence': 0.00010525238758418709}]	при прохождении Слота NLU	поле Name распознанных Интентов или Интента и ихconfidence	каждый раз при прохождении этого же или другого Слота NLU	Возможно
platform_chat_id	"Промежуточная версия” идентификатора Чата, предназначенная для сопоставления старых идентификаторов чатов с новыми идентификаторами	нет	Служебная переменная, пока не используется	Нет	Да, когда присутствует в контексте	40 символов: латинские буквы и цифры	1fab819e20c1e939ed14d7024d17653fb07a77dd	при создании нового Чата	Генерируется системой	нет	Невозможно
chat_language	В переменной хранится распознанный язык	нет	в Сценарий агента по желанию ДД	Нет	Да, когда присутствует в контексте	строка	Russian	при прохождении слота Language	Генерируется системой	каждый раз при прохождении этого же или другого Слота Language	Невозможно
channel_raw_response	json-объект, запрос, который отправляет Конечный канал в ответ на перевод на оператора/группу операторов	нет	при переходе по Сценарий агента после слота Change Chat Mode	Нет	Да, когда присутствует в контексте	json-объект, состоящий из ключа code и объекта body	{    "code": 200,    "body": {        "result": "ok"    }}	при прохождении слота Change Chat Mode	Конечный канал, к которому обращается Change Chat Mode	каждый раз при прохождении этого же или другого Слота Change Chat Mode	Невозможно
repeat_index	переменная используется для отражения номера текущей итерации цикла, нумерация итераций начинается с 0	нет									Невозможно
email_status	Результ отправки письма	нет	движение Агента по Сценарий агента	Нет	Да, когда присутствует в контексте	json-объект, состоящий из ключа task_id или error	{ "task_id": <идентификатор задачи> }	При прохождении слота Email		Каждый раз при следующем прохождении этого же или другого слота Email	Невозможно