AI Assistant UI

AI Assistant UI provides two AI interfaces for your Drupal site:

• Chatbot — a chat widget with streaming replies and conversation history.
• AI search answers — an AI-generated answer to the visitor's search, displayed as a block or Views area.

Both use the AI module's AI Assistant API. Your configured assistant supplies
the answers and can use tools and retrieval-augmented generation (RAG) to
answer from your site's content. The front end uses Drupal-native Single
Directory Components and Twig templates.

AI module: https://www.drupal.org/project/ai

Features

• Streaming replies when supported by the configured assistant and provider, or complete responses with streaming disabled.
• Conversation history per visitor session, with optional restoration after a page reload.
• Configurable suggested questions, introduction text, disclaimer and labels.
• Optional terms of service with visitor acceptance and revocation.
• Views integration that passes search keywords, exposed filters and facets to the assistant and refreshes with Views AJAX.
• Optional link preview cards and per-session caching for search answers.
• Rate limiting on chat and link preview requests.
• Drush commands to copy components and templates into your theme.

Requirements

• A Drupal core version supported by both this module and the selected AI release. AI 1.5.x requires ^10.5 || ^11.2.
• The AI module with its AI Assistant API submodule, a configured AI Assistant and an LLM provider.
• Additional tools and search infrastructure if your assistant should retrieve content through RAG.
• Recommended: league/commonmark for formatted Markdown responses; otherwise answers are shown as plain text.
• PHP's cURL extension when using link previews.

Installation

composer require 'drupal/ai_assistant_ui:^1.0@RC'
drush en ai_assistant_ui

Post-Installation

1. Configure an AI Assistant at
   Administration → AI → Assistants, including any tools needed
   to retrieve your site's content.
2. Place a block at Structure → Block layout:
   choose AI Assistant Chatbot or
   AI Assistant Search Results, then select your assistant.
   For a search view, add Global → AI Assistant answer
   to the view's header.
3. Configure search context: choose which filters and facets
   to pass to the assistant. Configure the assistant and its tools to apply
   these filters when retrieving content.
4. Add Markdown rendering if needed:
   composer require league/commonmark.
5. Customise the appearance: copy the component and template
   into your theme, then rebuild caches.

   drush aut-scaffold chatbot
   drush aut-scaffold search-results
   drush cr

Similar projects

The AI module's ai_chatbot submodule provides a DeepChat-based
chatbot. AI Assistant UI offers a Drupal-native interface using Single
Directory Components and Twig templates.

AI Search Block provides answers through its own configurable retrieval
workflow over indexed content. AI Assistant UI delegates answering to a
configured AI Assistant and provides both search blocks and Views integration.
See https://www.drupal.org/project/ai_search_block.

Supporting this Module

Developed and maintained by LOOM —
https://loom.de