Asyntai AI Chatbot
| Adds the Asyntai AI chat assistant to your wiki, and sends your wiki pages to Asyntai so the assistant answers from them. |
| Type | XAR |
| Category | Application |
| Developed by | |
| Rating | |
| License | Apache License 2.0 |
Table of contents
Description
The Asyntai extension does two things.
- It puts the Asyntai AI chat assistant on every page of the wiki.
- It sends the wiki pages to the Asyntai knowledge base, so the assistant answers from what the wiki says.
The second part is what makes the assistant useful on an internal wiki. Most wikis sit behind a login, so no crawler can read them. A nightly Scheduler job in your own wiki pushes the pages out instead. Only pages that changed are sent again, and a page you delete is removed from Asyntai on the next run.
Setup
- Install this extension.
- Open Administration, then Other, then Asyntai.
- Paste your Widget ID, which you find in the Asyntai dashboard. The chat assistant appears at once.
- To use the knowledge base sync as well, paste an Asyntai API key and set Send wiki pages to Asyntai to Yes.
- Open the Asyntai page from the Applications panel and press Run the sync now.
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. The spaces XWiki, Help, Sandbox, Menu, Scheduler, Panels, AppWithinMinutes, Stats, ColorThemes, FlamingoThemes, Mail and Asyntai are excluded from the start, and you can exclude more. A page shorter than 120 characters is skipped.
The job runs as one named person and sends exactly the pages that person can read. Your API key is stored on a page that only administrators can read.
Requirements
- XWiki 11.5 or later, with the XWiki Scheduler.
- Administration rights on the wiki.
- An Asyntai account. The chat assistant works on every plan, including the free one.
- A paid Asyntai plan for the knowledge base sync, because it uses the Asyntai API.
Documentation: https://asyntai.com/documentation/integrations/xwiki/
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Release Notes
v1.0
First release. Adds the Asyntai AI chat assistant to the wiki and pushes wiki pages to the Asyntai knowledge base.