# Плейбуки Shopping Assistant

Плейбук — это управляемый сценарий консультации для типовой задачи покупателя. Он задаёт условия применения, рекомендации по ответу и товарные группы, которые ассистент должен подобрать.

!!!warning Доступность
Раздел «Плейбуки» отображается только в секциях, где включено управление сценариями планирования.
!!!

## Найдите плейбук

![Каталог плейбуков демонстрационного магазина электроники](./assets/playbooks-catalog.png)

_Названия, версии и пользователи на скриншоте демонстрационные._

В каталоге показаны название и ID, статус, текущая версия, дата и автор последнего изменения.

- Используйте строку поиска для поиска по названию или ID.
- Выберите статус **Активные** или **Выключенные**, чтобы сузить список.
- Нажмите кнопку обновления, чтобы повторно загрузить данные.
- Нажмите на строку, чтобы открыть опубликованную версию.

## Создайте плейбук

1. Нажмите **Новый плейбук**.
2. Заполните название. Кабинет автоматически предложит ID.
3. Опишите, когда применять сценарий.
4. Добавьте примеры формулировок покупателя.
5. Добавьте инструкции для ответа.
6. Настройте товарные группы и запросы в каталог.
7. Нажмите **Опубликовать и включить**.

![Редактор нового плейбука для подбора рабочего места](./assets/playbook-editor.png)

_Сценарий и товарные группы на скриншоте демонстрационные._

### Поля плейбука

| Поле | Назначение |
| :--- | :--- |
| Название | Понятное команде название сценария. |
| ID | Стабильный технический идентификатор. |
| Описание сценария | Условия и покупательская задача, для которых нужен плейбук. |
| Примеры запросов | Реальные формулировки, по которым система распознаёт сценарий. |
| Инструкции | Требования к содержанию и структуре ответа. |
| Товарные группы | Полки или части решения, которые нужно найти в каталоге. |
| Запрос в каталог | Базовый запрос для соответствующей товарной группы. |

ID должен содержать от 3 до 64 строчных латинских букв, цифр или дефисов. До первой публикации его можно изменить. После публикации ID фиксируется.

Повторяемые поля можно добавлять, удалять и менять местами. Перед публикацией кабинет проверяет, что обязательные значения заполнены.

## Обновите опубликованный сценарий

Опубликованные поля доступны только для чтения. Чтобы внести изменения:

1. Откройте плейбук.
2. Нажмите **Редактировать**.
3. Измените нужные поля.
4. Нажмите **Опубликовать изменения**.

Изменения становятся новой активной версией. Предыдущая версия остаётся в истории и продолжает быть доступной для просмотра.

Если уйти со страницы с неопубликованными изменениями, кабинет попросит подтвердить действие.

## Проверьте срабатывание

Retrieval-тест доступен для активной опубликованной версии.

1. Откройте активный плейбук без режима редактирования.
2. В блоке «Проверка срабатывания» оставьте примеры из плейбука или добавьте новые запросы — по одному на строку.
3. Нажмите **Проверить запросы**.
4. Проверьте место плейбука и соседние сценарии для каждого запроса.

![Результаты проверки срабатывания плейбука на запросах покупателей](./assets/playbook-retrieval-test.png)

_Запросы и результаты ранжирования на скриншоте демонстрационные._

Результат «Сработал первым» означает первое место. «В числе первых» — попадание в первые три результата. Если сценарий оказался ниже или не сработал, уточните описание и примеры в новой версии, опубликуйте её и повторите тест.

Тест не изменяет плейбук и данные товарного каталога.

## Используйте историю версий

В панели «История» отображаются все версии сценария и их состояние. Нажмите на версию, чтобы открыть read-only превью.

Кнопка **Использовать как основу** копирует содержимое выбранной версии в новую редактируемую версию. Рабочий сценарий не изменится до публикации.

## Выключите плейбук

1. Откройте активную опубликованную версию.
2. В блоке «Выключение» нажмите **Выключить плейбук**.
3. Подтвердите действие.

Плейбук перестанет участвовать в подборе, но история версий сохранится. Чтобы вернуть сценарий в работу, создайте и опубликуйте новую версию.