Глоссарий терминов Slen

Слова, которыми пользуются консоль и этот справочник, — операция, флоу, версия, выполнение, резерв, пул, клиент, кредиты — и что значит каждое.

5 мин чтения

Консоль, API и этот справочник называют одни и те же вещи одними и теми же именами. Эта страница говорит, что значит каждое имя. Термины стоят группами, в том порядке, в каком их встречает запрос. В скобках — английское слово, которым термин назван в API и в английской версии консоли.

Запросы

Термин	Что это
Операция (operation)	Один вызов модели во флоу со всем, что с ним произошло, — попытки, резерв, стоимость. Список — на экране Операции.
Код операции (operation code)	Имя, которое вы даёте виду запросов, например `generate_email`. Запрос, который запускает флоу, называет свой код, и код решает, какой флоу запустится.
Привязка операции (operation binding)	Соответствие между кодом операции и флоу, оно задаётся в настройках флоу. Один код принадлежит одному флоу проекта, и у флоу один код. См. AI-флоу.
Выполнение (execution)	Один запуск флоу. Законченное выполнение имеет статус `completed`, `rejected`, `failed` или `uncertain`. Незаконченное — `queued`, `running` или `waiting`.
Трассировка (trace)	Запись выполнения — узел за узлом, событие за событием.

Флоу

Термин	Что это
Флоу, AI-флоу (flow)	Граф, который решает, сколько запросу можно потратить. См. Как устроен флоу.
Конструктор флоу (flow builder)	Редактор флоу — палитра узлов, холст и инспектор узла.
Холст (canvas)	Поверхность конструктора, на которой стоят узлы флоу.
Узел (node)	Один шаг флоу.
Порт (port)	Именованный выход узла. См. Порты и ветвление.
Связь (connection)	Линия от порта одного узла к другому узлу. Подключение провайдера — другая вещь, о нём ниже.
Ветка (branch)	Путь, который начинается в порту.
Входной узел (entry node)	Узел, с которого начинается флоу, — Запрос. Во флоу он один.
Конечный узел (terminal node)	Узел, который заканчивает путь, — Вернуть ответ или Отклонить запрос.
Шаблон (template)	Готовый флоу, с которого можно начать. Галерея — на экране Шаблоны.

Версии

Термин	Что это
Версия (version)	Пронумерованное состояние флоу. Версия — это либо черновик, либо опубликованная версия, и опубликованная версия никогда не меняется. См. Публикация, версии и откат.
Черновик (draft)	Версия, которую сейчас редактируют. У флоу не больше одного черновика, и запросы его никогда не запускают.
Опубликовать (publish)	Проверить черновик и, если в нём нет ошибок, сделать его опубликованной версией. С этого момента флоу запускает эту версию.
Активная версия (active version)	Опубликованная версия, которую запускают запросы. До отката это последняя опубликованная, после отката — та, на которую откатились. Черновик флоу начинается с активной версии. Вкладка Версии флоу показывает у неё статус Активная.
Откатить (roll back)	Сделать активной другую опубликованную версию. Выполнений, которые уже идут, это не затрагивает.

Деньги

Термин	Что это
Оценка (estimate)	Сколько ожидаемо будет стоить вызов — считается до самого вызова. Оценка ничего не тратит.
Резерв, холд (reservation, hold)	Деньги, отложенные под вызов до того, как он сделан. Деньги держит только резерв в статусе `authorized`. Консоль называет резерв ещё и словом «удержание». Чем различаются статусы, объясняет статья Как работает резервирование бюджета.
Авторизация (authorization)	Резерв в том виде, в каком его записывают API и консоль, — сумма, статус и то, что списано. Вкладка — на экране Операции, см. статью Операции, авторизации и реестр.
Списание (capture)	Закрыть резерв по тому, сколько вызов стоил на самом деле. Остаток резерва возвращается.
Возврат (release)	Вернуть резерв целиком. Ничего не списывается.
Реестр (ledger)	Список движений денег проекта. Записи в него только добавляются и никогда не меняются.
Бюджет (budget)	Потолок расходов проекта или организации. Он задаётся в деньгах или, для одного вида бюджета, в числе резервов, которые держатся одновременно.
Политика (policy)	Правило, которое применяется к запросу до того, как деньги зарезервированы. Оно отклоняет запрос или меняет его лимиты.

Провайдеры и модели

Термин	Что это
Провайдер (provider)	Компания, модели которой вызываются.
Подключение провайдера (provider connection)	Учётные данные одного аккаунта провайдера, через который Slen вызывает модели.
Пул провайдеров (provider pool)	Группа подключений провайдеров и стратегия, по которой одно из них выбирается для вызова.
Модель (model)	Модель из каталога с ценами её токенов. Каталог — на экране Модели.
Попадание и промах кеша (cache hit, cache miss)	Попадание значит, что в кеше есть ответ на запрос, и флоу может ответить, не вызывая модель. Промах значит, что ответа в кеше нет.

Клиенты

Термин	Что это
Клиент (customer)	Ваш конечный клиент. Slen знает клиента по идентификатору, который ему даёт ваше приложение, — `external_user_id`; запрос, запускающий флоу, отправляет его в `context.user_id`.
Кредиты (credits)	Единица, в которой вы считаете потребление своих клиентов. Кредиты — не деньги. Вызов модели резервирует кредиты до запуска, тратит их при списании и получает обратно при возврате.
Счёт (credit account)	Кредиты одного клиента одного типа: баланс, зарезервированное и настройки — может ли счёт уходить ниже нуля и когда он предупреждает. У клиента по счёту на каждый тип кредитов.
Списание (charge)	Кредиты, которые ваше приложение само снимает с клиента за то, что продаёт вне флоу. Списание — не расход вызова.
Блокировка (block)	Остановка запусков одного клиента: его новые запуски отклоняются, а его кредиты по-прежнему можно двигать. См. Кредиты клиентов.

Доступ

Термин	Что это
Организация (organization)	Ваша компания в Slen. В ней находятся проекты, участники и общие для них настройки.
Проект (project)	Часть организации со своими API-ключами, флоу и операциями.
Участник (member)	Человек в организации, у которого есть роль.
API-ключ (API key)	Секрет, который сервис отправляет с каждым запросом. Ключ принадлежит одному проекту. См. Управление API-ключами.
Разрешение (scope, permission)	То, что ключу можно делать. См. Аутентификация.
Согласование (approval)	Решение, которого ждёт выполнение. Человек одобряет или отклоняет его на экране Согласования.
Оповещение (alert)	Сообщение о том, что условие, для которого вы задали правило, стало истинным.
Уведомление (notification)	Сообщение, которое Slen отправляет человеку или в чат команды об оповещении или согласовании. См. Уведомления.
Вебхук (webhook)	Запрос, который Slen отправляет вашему сервису, когда происходит событие.
Журнал аудита (audit log)	История действий и изменений в организации.