AACSearch / руководство
Обзор консоли
Дашборд организации: права доступа, взаимодействие с API и все экраны боковой панели.
Консоль — это веб-дашборд, в котором организация работает с AACSearch:
создаёт коллекции и индексирует документы, настраивает релевантность, конфигурирует
ИИ-ассистентов, изучает аналитику, публикует страницу поиска, управляет командой и
биллингом. Консоль доступна по адресу (https://app.aacsearch.com)
и представляет собой приложение Next.js поверх той же управляющей плоскости и
API тенанта, которые описаны в этой документации.
Всё в консоли относится к активной организации. Пользователь может состоять в нескольких организациях; переключатель организаций в боковой панели определяет, какую из них читает и изменяет каждый экран.
Как консоль обращается к API
Дашборд использует два пути, и полезно знать, какой из них задействует экран, когда вы ищете эквивалентный вызов API:
| Путь | Для чего используется | Аутентификация |
|---|---|---|
Управляющая плоскость (oRPC) | Организации, участники, API-ключи, биллинг, кошелёк, вебхуки, журнал аудита, агрегаты аналитики, лаборатория качества, оповещения, настройки хостинга. | Сессионная cookie better-auth. |
API тенанта (/v1/*) | Всё, чем владеет поисковый движок: коллекции, документы, поисковые правила, синонимы, курирование, пресеты, коннекторы, ассистенты, модели. | Та же сессионная cookie, по которой API определяет активную организацию и роль участника, — API-ключ в консоли не хранится. |
Владельцы и администраторы могут вносить изменения; участники имеют доступ только на чтение. Вызов управляющей плоскости без активной организации завершается ошибкой, поэтому экраны предлагают выбрать или создать организацию.
Кто что видит
- Клиенты — владелец, администратор или участник собственной организации — видят продуктовые экраны: данные, поиск, ИИ, аналитику, публикацию и организацию.
- Администраторы организации дополнительно видят деструктивную Danger zone в Settings и являются единственными участниками, от которых API принимает изменения.
- Операторы платформы — аккаунты из
PLATFORM_ADMIN_EMAILSв API — дополнительно получают группу Platform в боковой панели (поисковый кластер, планировщик, исходные ресурсы) и стоящие за ней операции уровня всего движка. API проверяет это независимо, поэтому клиент, который вводит URL платформы, получает вежливый отказ, а не данные. - Ограничения тарифа — функции, не входящие в ваш тариф, отмечаются в боковой панели значком замка, а на странице выводится пояснение FeatureGate со ссылкой на экран смены тарифа. Бесплатный тариф всегда включает поиск, синонимы и стоп-слова; см. Тарифы, использование и биллинг.
Обзор
/dashboard — стартовый экран; корень консоли / перенаправляет на него.
Вверху расположены три карточки статуса, каждая ведёт на экран, где можно принять меры:
- Search service — работает или недоступен, ссылка на Alerts & SLOs.
- Requests — использование относительно месячного лимита, название тарифа и бейдж Exhausted, когда квота исчерпана, ссылка на Billing.
- Credits — баланс кошелька и бейдж Empty, ссылка на Billing.
Ниже блок состояния продукта сообщает о четырёх вещах: данные (число документов и коллекций, с подсказкой, если коллекции пусты), поиск (доля запросов без результатов за 30 дней или число таких запросов и CTR, ссылка на Search issues), рекомендации (сколько моделей есть у основной коллекции) и ИИ (число ассистентов, с бейджем об отсутствии кредитов).
Строка Suggested actions предлагает следующие полезные шаги — загрузить документы, подключить источник, открыть лабораторию качества, посмотреть проблемы поиска, пройти быстрый старт — и скрывает напоминание о быстром старте после его закрытия (запоминается в браузере). Сетка Collections показывает каждую коллекцию с числом документов и полей и датой создания или пустое состояние «create your first collection». Карточка Organizations перечисляет организации, в которых вы состоите, с отметкой активной и действием Switch, а также New organization; если активной организации нет, карточка предлагает её создать, а для приостановленной организации показывается баннер «API access is paused (reason)» со ссылкой на Billing.
Каждый раздел загружается и завершается ошибкой независимо, поэтому неудачный запрос затрагивает только свою карточку, а не весь экран.
Навигация
Боковая панель упорядочена так, как клиент знакомится с продуктом: загрузить данные, настроить качественный поиск, добавить ИИ, измерить, опубликовать — а затем собственные дела организации. Командная палитра (⌘K / Ctrl-K) ищет по тем же экранам.
| Группа | Экраны |
|---|---|
| Start | Overview (/dashboard, / перенаправляет сюда), Quick start |
| Data | Collections, Documents, Sources, Integrations, Migrate from Algolia — см. Данные и индексация |
| Search | Search preview, Playground (Search, Chat), Relevance (Search rules, Synonyms, Synonym suggestions, Curation, Stopwords, Stemming, Presets, Aliases), Semantic & image, Query intelligence, Natural-language search — см. Поиск и релевантность |
| AI | Assistants, Conversations, Conversation models, Recommendations, Personalization, Knowledge graph — см. Функции ИИ |
| Insights | Analytics, Search issues, Analytics rules, Experiments, Campaigns, Quality lab, Autopilot, Observability (Query log, Sessions, Latency), Alerts & SLOs — см. Аналитика и качество |
| Publish | Storefront, Hosted page, Webhooks, Support inbox — см. Публикация и поддержка |
| Organization | Team, Usage, Billing, Audit log, Settings (General, API keys, Security, Danger zone) — см. Организация и биллинг |
| Platform | Search cluster, Scheduler, Raw resources — только для операторов платформы, см. Операции платформы |
Быстрый старт
/dashboard/quick-start — чек-лист онбординга из шести шагов с индикатором
прогресса и бейджем Done / Up next / Pending у каждого шага. Раскрыв
шаг, вы увидите его описание и ссылки для его выполнения:
Создайте коллекцию
Схему для индексируемых документов.
Проиндексируйте документы
С помощью копируемого фрагмента curl, встроенного импорта консоли или
коннектора.
Выполните первый поиск
Шаг засчитывается, когда поиск выполнен в предпросмотре поиска или на площадке (playground) либо создан ассистент.
Создайте API-ключ
Полный ключ для сервера или ключ с областью доступа (scope) поиска для браузера.
Разместите поиск на сайте (необязательно)
Виджет, фрагмент для React или SDK.
Опубликуйте хостинговую страницу (необязательно)
Страницу поиска и чата, которую платформа обслуживает за вас.
Чек-лист независимо проверяет коллекции, коннекторы, ассистентов, ключи и хостинг каждый раз, когда окно снова получает фокус, поэтому шаг отмечается сам, если работа выполнена в другом месте; при сбое проверки показывается «Could not check every step» с Retry, а кнопка Refresh вверху запускает все проверки заново. Некоторые шаги нельзя определить на сервере, поэтому они запоминаются локально в браузере. Hide reminder скрывает напоминание на экране Overview.
Матрица готовности
/dashboard/capabilities — матрица готовности для всего аккаунта. Каждая
основная область консоли представлена строкой и проверяется дважды: по
ограничению тарифа из флагов функций квоты и живой проверкой управляющей
плоскости (коллекция с документами, подключённый источник, созданный ассистент,
рабочий ключ, включённая хостинговая страница, отвечающий кошелёк).
Возможны четыре статуса: Ready (тариф разрешает функцию и проверка дала положительный ответ), Not configured (разрешено, но не настроено), Plan gated (тариф не включает функцию — строка показывает бейдж «Plan feature», а её кнопка становится View plans) и Unknown (проверка не удалась; деградируют только её строки, а не вся страница). Строка заголовка подсчитывает их — «plan plan · N ready · N not configured · N plan-gated · N unknown», — а Refresh перезапускает все проверки. Без активной организации экран предлагает выбрать её на Overview.
Ссылки на этот экран в боковой панели нет — откройте /dashboard/capabilities
напрямую. Второй экран, не указанный в панели, — /dashboard/ranking,
Ranking Studio.