asyntai / neos-ai-chatbot
Asyntai AI Chatbot for Neos CMS: an AI chat assistant on every page that answers visitor questions from your own website content.
Package info
github.com/asyntai/neos-ai-chatbot
Type:neos-plugin
pkg:composer/asyntai/neos-ai-chatbot
Requires
- php: >=8.0
- neos/neos: ^8.3 || ^9.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Add the Asyntai AI chat assistant to your Neos website. It answers visitor questions from your own website content, day and night, in more than 80 languages.
Works with Neos 8.3 and Neos 9.
Install
composer require asyntai/neos-ai-chatbot
Then open the Neos backend and go to Administration > Asyntai AI Chatbot.
- Click Connect to Asyntai.
- Sign in, or create a free account, in the window that opens.
- The window closes and the module saves the connection.
The chat bubble is now on every page of your website.
You can also paste your widget ID into the module and click Save. Find the
widget ID on the Install page of your
Asyntai dashboard. It starts with asyntai_.
Configuration in code
Teams that keep configuration in code can set the widget ID in
Configuration/Settings.yaml instead. A widget ID set there always wins over
the module.
Asyntai: AiChatbot: widgetId: 'asyntai_1a2b3c4d5e6f'
| Option | Default | What it does |
|---|---|---|
enabled |
true |
Set to false to hide the chatbot and keep the connection |
widgetId |
empty | Your Asyntai widget ID. Overrides the module |
scriptUrl |
the Asyntai CDN | Advanced. Load the widget from another URL |
What the package does
- It adds one small script in front of the closing body tag of every HTML page of your website. The widget loads after the page itself, so your pages stay fast.
- It works with every site package, because it does not depend on your Fusion page prototype.
- The Neos backend and the editing and preview frames stay as they are.
- If a page already has the Asyntai snippet, for example in a template, the package leaves that page alone.
- The connection made in the module is saved in
Data/Persistent/Asyntai.AiChatbot/connection.json, so cache flushes and deployments keep it.
Answering from your content
Asyntai reads your published pages. The assistant answers from the same pages the widget sits on. You can also add documents, and question and answer pairs, in the dashboard.
Removing it
Click Disconnect in the module, or run
composer remove asyntai/neos-ai-chatbot. The widget is gone.
Support
Email hello@asyntai.com, or read the Neos guide.
Licence
MIT. See LICENSE.