Инструменты вызываются самим ассистентом по вашей задаче. Этот справочник помогает понять, какие действия доступны, какие данные используются и какие права нужны.
Список инструментов и права
| Инструмент | Назначение | Право |
|---|---|---|
project_search | Поиск проектов | projects:read |
report_options | Получение информации о проекте | projects:read |
report_history | Получение истории отчётов проекта | reports:read |
report_generate | Генерация и пересчёт отчёта | reports:create |
report_get | Получение карточки отчёта | reports:read |
report_get_block_data | Получение данных и схемы настроек блока | reports:read |
report_set_block_comment | Замена комментария | reports:read + reports:write |
report_edit_structure | Правка структуры отчёта | reports:read + reports:write |
Ассистенту доступны только инструменты, разрешённые при подключении. Если выданы только права чтения, создавать и изменять отчёты он не сможет. Чтобы изменить права, отключите подключение и подключитесь заново с нужными разрешениями.
Многие клиенты показывают вызовы инструментов и их параметры прямо в чате. Таблицы и примеры ниже помогут понять, что именно ассистент передал в SEO Reports.
project_search: поиск проекта
Ищет проекты вашего аккаунта по части названия или адреса сайта. Проекты других аккаунтов ассистенту недоступны.
| Параметр | Значение |
|---|---|
query | Необязательная строка, часть названия или адреса. Без неё будет возвращён весь список проектов. |
page | Номер страницы, по умолчанию 1. На странице 20 проектов. |
Если подходящих проектов несколько, назовите ассистенту точный адрес сайта или выберите проект из найденных.
report_options: информация о проекте
Показывает, какие шаблоны доступны проекту, какой из них используется по умолчанию и был ли у проекта отчёт раньше. Ассистент вызывает инструмент перед генерацией, чтобы выбрать шаблон.
Если вы не указали шаблон, ассистент может взять шаблон по умолчанию. Если его нет, а доступных шаблонов несколько, назовите нужный сами.
Настройки источников, целей и рекламных кампаний подставляются автоматически: из последнего отчёта, автогенерации или настроек по умолчанию. Перечислять их в запросе не нужно. Чтобы изменить их, настройте отчёт в кабинете.
report_history: история отчётов
Показывает отчёты, уже собранные по проекту, — тот же список, что история отчётов в кабинете, от новых к старым. Ассистент использует его, когда вы просите открыть существующий отчёт, например «отчёт за август»: находит строку с нужным периодом и дальше работает с этим отчётом, не собирая новый.
| Параметр | Значение |
|---|---|
project_id | Проект из результатов поиска. |
page | Номер страницы, по умолчанию 1. На странице 20 отчётов. |
Для каждого отчёта в ответе есть отчётный период, период сравнения, дата генерации, статус и ссылка на просмотр. Отчёты автогенерации отмечены отдельно (auto). За каждый день в истории остаётся последний ручной и последний автоматический отчёт.
history_forbidden). Последний отчёт проекта доступен на любом тарифе: ассистент получит его через report_options.report_generate: генерация отчёта
Собирает отчёт за выбранный период или пересчитывает уже собранный. В запросе укажите проект, период с годом и при необходимости период сравнения и шаблон.
| Параметр | Значение |
|---|---|
project_id | Проект, по которому собирается отчёт. |
period_from / period_to | Начало и конец периода в формате YYYY-MM-DD. |
template_id | Шаблон отчёта. Если не указан, используется шаблон проекта по умолчанию. |
comparison_from / comparison_to | Период сравнения. Указываются обе даты или ни одной. |
refresh | Пересчитать отчёт заново. По умолчанию false. Включается, только если вы прямо попросили пересчёт. |
make_public | Открыть отчёт по ссылке без входа в кабинет. По умолчанию false. Включается, только если вы прямо попросили гостевую ссылку. |
В ответе ассистент получает идентификатор отчёта, статус сборки, ссылку на просмотр и предупреждения. Повторный запрос с теми же параметрами без пересчёта обычно возвращает уже собранный отчёт.
preview_public).report_get: карточка отчёта
Показывает состояние отчёта: собирается он или готов, ссылку на просмотр, доступ для гостей, предупреждения и список блоков. Если отчёт ещё собирается, инструмент ждёт около 20 секунд. Если сборка затянулась, попросите ассистента проверить отчёт позже.
Когда отчёт готов, ассистент даёт ссылку и сообщает о предупреждениях, например об отключённом источнике. Если сборка завершилась ошибкой, в ответе будет её код (error_code). Из карточки ассистент берёт коды блоков (block_ref) и версию отчёта (revision) для следующих действий.
report_get_block_data: данные блока
Читает цифры выбранного блока, например трафика или поисковых фраз, и схему его настроек: какие параметры есть и какие значения допустимы. По цифрам ассистент готовит выводы, а по схеме меняет настройки блока.
| Параметр | Значение |
|---|---|
report_id | Отчёт. |
block_ref | Блок из карточки отчёта. |
max_rows | Сколько строк получить в каждой таблице блока: от 1 до 500, по умолчанию 50. |
Большие таблицы сокращаются: строк приходит не больше max_rows, а при большом объёме ответа — ещё меньше. Сокращение отмечается в ответе (truncated). Учитывайте, что выводы по такой таблице сделаны по её части. Полные данные блока можно получить через REST API.
report_set_block_comment: комментарий к блоку
Сохраняет комментарий над данными блока или под ними, например вывод, который ассистент подготовил по цифрам. Перед сохранением попросите показать текст и проверьте его.
| Параметр | Значение |
|---|---|
report_id / block_ref | Отчёт и блок. |
html | Текст комментария в простом HTML. |
expected_revision | Версия отчёта, которую ассистент прочитал последней. Не даёт записать комментарий поверх чужих правок. |
position | Над данными (top) или под ними (bottom, по умолчанию). У текстовых блоков только top. |
mode | replace — заменить текущий комментарий (по умолчанию), append — дописать к нему. |
append.report_edit_structure: структура отчёта
Меняет порядок блоков, их видимость, заголовки и настройки, добавляет и удаляет текстовые блоки. Несколько правок ассистент применяет одной операцией в заданном порядке.
| Операция | Что делает |
|---|---|
move | Переносит блок после другого блока, в начало (START) или в конец (END). |
enable / disable | Включает или скрывает блок. Скрытый блок остаётся в отчёте, его можно включить снова. |
set_title | Меняет заголовок блока. |
set_settings | Меняет настройки блока. Допустимые значения берутся из схемы настроек блока. |
add_text_block | Добавляет текстовый блок с заголовком и текстом, по умолчанию в конец отчёта. |
remove_text_block | Удаляет текстовый блок. Обычные блоки так не удаляются, их можно только скрыть. |
Если отчёт изменили после того, как ассистент его прочитал, правка не сохранится: вернётся ошибка revision_conflict. Попросите ассистента перечитать отчёт и повторить изменения. Включение блока может быть недоступно по тарифу или доступам к источникам.
Как инструменты складываются в задачу
Новый отчёт: project_search → report_options → report_generate → report_get. Готовый отчёт: project_search → report_history → report_get. Вывод к блоку: report_get → report_get_block_data → анализ → report_set_block_comment. Готовые формулировки задач — в примерах, разбор ошибок — в диагностике.