XWiki Integration
Put an AI assistant on your wiki, and let it answer from your wiki pages
Overview
The Asyntai extension for XWiki does two things. It puts the chat assistant on every page of your wiki, and it sends your wiki pages to Asyntai so the assistant answers from them. Your staff then ask a question in plain words instead of reading through hundreds of pages.
How It Works
Most wikis sit behind a login, so no crawler can read them. The extension solves that from inside: a nightly job in your wiki sends new and changed pages to your Asyntai knowledge base. Only pages that changed are sent again, and a page you delete is removed from Asyntai on the next run.
Requirements
- XWiki 11.5 or later, with the XWiki Scheduler that ships with it
- Administration rights on the wiki
- An Asyntai account. Creating one is free, and the Free plan is enough for the chat widget.
- A paid Asyntai plan for the knowledge base sync, because it uses the Asyntai API
Installation
Follow these steps to add Asyntai to your wiki:
Install the Extension
Open Administration, then Extensions, and search for Asyntai. Install it. You can also import the XAR file from Administration, then Import.
Copy Your Widget ID
Open the Install page in your Asyntai dashboard. Your widget ID is the value of data-asyntai-id in the snippet shown there.
data-asyntai-id="asyntai_xxxxxxxxxxxx"
Paste It Into the Wiki
Open Administration, then Other, then Asyntai. Paste your widget ID and save. The chat assistant appears on every page at once.
Add Your API Key
On the same screen, paste an Asyntai API key and set Send wiki pages to Asyntai to Yes. Skip this step if you only want the chat widget.
Start the Sync
Open the Asyntai page from the Applications panel. Press Run it as me from now on, then press Run the sync now. After that the sync runs every night.
Tip: Add your documents, questions and answers, and your instructions in the Asyntai Dashboard before you publish, so the assistant answers properly from the first visitor.
What the Sync Sends
- The title and the text of each page, as plain text, with a link back to the wiki
- Nothing else. No user names, and no visitor data.
- Hidden pages are never sent, so technical pages stay out of the knowledge base
- Spaces such as XWiki, Help and Sandbox are excluded from the start, and you can exclude more
- A page shorter than 120 characters is a stub, so it is skipped
Who the Sync Runs As
The job runs as one named person, and it sends exactly the pages that person can read. The button on the Asyntai page sets that person to you. This matters, because everybody who can use the chat assistant can then ask about anything the sync sent.
Removing It
Uninstall the extension from Administration, then Extensions. The chat assistant and the sync job disappear at once. Pages already sent stay in your Asyntai knowledge base until you delete them there.
Privacy
Your wiki sends page titles and page text to Asyntai, and nothing else. Your API key is stored on a page that only administrators can read. Leave the sync switched off to send nothing at all, and the chat widget still works. Privacy policy.
Plans & Pricing
The extension is free. The chat widget works on every Asyntai plan, including the Free plan. The knowledge base sync needs a paid plan, because it uses the Asyntai API. View pricing.
Need Help?
If you have any questions or run into issues, contact us at [email protected].