Орнату және баптау құжаттамасы

AI Search - умный ИИ поиск по сайту для DataLife Engine

Түрі: DataLife Engine үшін модульдер DLE: 20.0 Файл нұсқасы: 0.1

Установка AI Search:

  1. Перейдите в админпанель DataLife Engine → Плагины.
  2. Загрузите файл aisearch.xml и активируйте плагин.
  3. Откройте файл engine/modules/aisearch.php.
  4. Найдите функцию aisearch_cfg() и настройте подключение к AI.

Настройка подключения AI:

Для работы поиска необходимо подключить AI API. Плагин поддерживает OpenAI-совместимые API, поэтому вы можете использовать различные AI-провайдеры и модели.

В файле engine/modules/aisearch.php найдите следующие параметры:

'api_url' => 'https://api.openai.com/v1/chat/completions',
'model' => 'gpt-4o-mini',
'api_keys' => '',
'timeout' => 60,
  1. api_url — адрес API-сервера вашего AI-провайдера.
  2. model — название используемой AI-модели.
  3. api_keys — API-ключ или несколько ключей через запятую.
  4. timeout — максимальное время ожидания ответа от AI в секундах.

Вы можете подключить любую совместимую модель, изменить провайдера и использовать собственные API-ключи.

Автоматическая ротация ключей: если указано несколько API-ключей через запятую, плагин автоматически переключается между ними по кругу при ошибках подключения или использовании лимитов.

Вывод кнопки AI Search:

Для открытия окна поиска добавьте в нужное место шаблона сайта (например, main.tpl или header.tpl) следующий код:

<button type="button" class="aisearch-open">AI поиск</button>

После этого при нажатии на кнопку будет открываться модальное окно поиска.

Настройка шаблона поиска:

Для изменения внешнего вида окна поиска вы можете использовать собственный шаблон.

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

Структура шаблона aisearch.tpl:

  • [item] ... [/item] — блок одного найденного материала.
  • [not-item] ... [/not-item] — отображается, если ничего не найдено.
  • {aisearch-chips} — место для вывода популярных поисковых запросов.

Внутри блока [item] доступны стандартные теги DLE, используемые в шаблонах новостей, включая дополнительные поля.

Обязательные идентификаторы элементов:

#aisearch-overlay
#aisearch-form
#aisearch-input
#aisearch-body
#aisearch-hp

Для кнопок закрытия окна используется атрибут:

data-aisearch-close

Пример оформления найденных материалов:

[item]
<article class="aisearch-item">
    <a href="{full-link}">
        [xfgiven_poster]
        <img src="[xfvalue_poster image-url="1"]" alt="">
        [/xfgiven_poster]
        <div class="aisearch-item_txt">
            <div class="aisearch-item_title">{title}</div>
            <div class="aisearch-item_meta">{short-story limit="80"}</div>
        </div>
    </a>
</article>
[/item]

[not-item]
<p class="aisearch-empty">Ничего не найдено на сайте</p>
[/not-item]

Основные настройки AI Search:

Все параметры находятся в функции aisearch_cfg() файла engine/modules/aisearch.php.

  • enabled — включение или отключение модуля (1 — включен, 0 — выключен).
  • api_url — адрес OpenAI-совместимого API.
  • model — название используемой AI-модели.
  • api_keys — API-ключи через запятую с автоматической ротацией при ошибках.
  • timeout — время ожидания ответа AI в секундах.
  • result_limit — количество найденных материалов (от 1 до 20).
  • cache_ttl — время хранения кеша в секундах (604800 — 7 дней, 0 — отключить кеш).
  • button_selector — CSS-селектор кнопки открытия поиска.
  • template — название файла шаблона без расширения .tpl.
  • popular_limit — количество популярных поисковых запросов (0 — отключить).
  • require_login — ограничение поиска только для авторизованных пользователей (1 — да, 0 — нет).
  • min_interval — минимальный интервал между запросами с одного IP в секундах.
  • limit_per_min — максимальное количество AI-запросов с одного IP за минуту.
  • limit_per_hour — максимальное количество AI-запросов с одного IP за час.
  • limit_per_day — максимальное количество AI-запросов с одного IP за сутки.

Как работает поиск:

  1. Пользователь вводит запрос обычным языком.
  2. AI анализирует запрос, определяет основную тему и подбирает ключевые слова и синонимы.
  3. Плагин ищет подходящие материалы по заголовкам, тексту, тегам и дополнительным полям.
  4. Общие слова не засоряют результаты — учитывается смысл и тематика запроса.
  5. Если найдено много материалов, AI дополнительно анализирует кандидатов и отбирает наиболее подходящие.
  6. Повторные запросы могут обрабатываться из кеша без повторного обращения к AI.

Безопасность и ограничения:

  • Проверка DLE user_hash.
  • Honeypot-защита от автоматических запросов ботов.
  • Ограничение количества запросов по IP.
  • API-ключи хранятся на сервере и не передаются в браузер.
  • Кеш запросов хранится в engine/cache/system/aisearch/ и защищён от прямого доступа через .htaccess.

Для публичных сайтов с платным AI API рекомендуется включить ограничение доступа для авторизованных пользователей (require_login = 1) и установить более строгие лимиты запросов.

Частые вопросы:

Поиск ничего не находит или показывает неподходящие материалы.

  • Проверьте правильность API-ключа, адреса API и названия модели.
  • Очистите кеш в папке engine/cache/system/aisearch/.
  • Убедитесь, что нужные материалы опубликованы и имеют статус approve.

Появляется ошибка «API не подключён».

Проверьте параметр api_keys в файле engine/modules/aisearch.php. Убедитесь, что API-ключ указан правильно.

Модальное окно не открывается.

  • Проверьте наличие кнопки с классом aisearch-open.
  • Убедитесь, что модуль включён: enabled = 1.
  • Проверьте правильность CSS-селектора в параметре button_selector.

Как изменить внешний вид поиска?

Отредактируйте файл templates/ВАШ_ШАБЛОН/aisearch.tpl.

Тауарға оралу