Manual:Extension/ChatBot: Difference between revisions

No edit summary
mNo edit summary
Line 2: Line 2:


== Starting a conversation ==
== Starting a conversation ==
If the chatbot is enabled in the wiki,  the interface provides a chat assistant that can answer questions related to your wiki. Click the Chat button at the end of the page to open the chat.
If the chatbot is enabled in the wiki,  the interface provides a chat assistant that can answer questions related to your wiki. Click the "Chat" button at the end of the page to open the chat.
[[File:chatbot button.png|alt=Chatbot button|center|thumb|134x134px|Opening the chat window]]
[[File:chatbot button.png|alt=Chatbot button|center|thumb|134x134px|Opening the chat window]]


Line 9: Line 9:
* '''(1) Buttons to resize or close the chat:'''
* '''(1) Buttons to resize or close the chat:'''
** ''resize chat:'' The size of the chat window has 3 different settings.
** ''resize chat:'' The size of the chat window has 3 different settings.
** ''minimize chat:'' The chat window is hidden, but not closed... Clicking on the chat button again restores the current session.
** ''minimize chat:'' The chat window is hidden, but not closed. Clicking the chat button again restores the current session.
** ''close chat and delete chat history:''  The chat window is closed and the chat history of the session is deleted.
** ''close chat and delete chat history:''  The chat window is closed and the chat history of the session is deleted.
* '''(2)  Question with timestamp:''' Once a conversation has been started by sending it from the message prompt area, the question appears with a timestamp in the chat window.
* '''(2)  Question with timestamp:''' Once a conversation has been started by sending a question from the message prompt area, it appears with a timestamp in the chat window.
* Answer to the question with the following elements:
* Answer to the question with the following elements:
** '''(3)  the answer text'''
** '''(3)  the answer text'''
Line 27: Line 27:
'''To exclude a page as a data source for the chatbot:'''
'''To exclude a page as a data source for the chatbot:'''


# '''Click''' the ''Options'' menu in the visual editor toolbar.[[File:VE page options menu item.png|alt=Options menu of VisualEditor|center|thumb|150x150px|Page options menu]]
# '''Click''' the ''Options'' menu in the visual editor toolbar.[[File:VE page options menu item.png|alt=Options menu of VisualEditor|center|thumb|150x150px|Page options menu]]
# '''Click''' ''Advanced settings''.
# '''Click''' ''Advanced settings''.
# '''Click''' ''No, do not index'' after the label ''Can be indexed for ChatBot'', users can check this requirement in the visual editor toolbar under Options > Advanced options.  
# '''Click''' ''No, do not index'' after the label ''Can be indexed for ChatBot.'' Users can check this requirement in the visual editor toolbar under Options > Advanced options.


​This adds the behavior switch <code>__NO_RAG_EXPORT__</code> to the page source.
​This adds the behavior switch <code>__NO_RAG_EXPORT__</code> to the page source.
== Configuration manager ==
== Configuration manager ==
An administrator can configure the name of the bot that is shown at the beginning of the chat window  in the [[Manual:Extension/BlueSpiceConfigManager|Config Manager]] under extension ''ChatBot''.
An administrator can configure the name of the bot that is shown at the beginning of the chat window  in the [[Manual:Extension/BlueSpiceConfigManager|Config Manager]] under extension ''ChatBot''.

Revision as of 08:37, 11 November 2025


ChatBot is available from BlueSpice 5.2. This extension has multiple prerequesites before it is available to users in a wiki.


Starting a conversation

If the chatbot is enabled in the wiki, the interface provides a chat assistant that can answer questions related to your wiki. Click the "Chat" button at the end of the page to open the chat.

Chatbot button
Opening the chat window

The chat window

Introduction page of the BlueSpice user manual with an open chat window.
Chatbot window

The chat window has the following main features:

  • (1) Buttons to resize or close the chat:
    • resize chat: The size of the chat window has 3 different settings.
    • minimize chat: The chat window is hidden, but not closed. Clicking the chat button again restores the current session.
    • close chat and delete chat history: The chat window is closed and the chat history of the session is deleted.
  • (2) Question with timestamp: Once a conversation has been started by sending a question from the message prompt area, it appears with a timestamp in the chat window.
  • Answer to the question with the following elements:
    • (3) the answer text
    • (4) resources: the page references that were used as a data source
    • (5) buttons to copy the answer to the clipboard or to save it as a wiki page (as a subpage of the current user's user profile page, e.g. User:WikiSysop/Bot/...)
  • (6) Suggested follow-up questions
  • (7) Message prompt area

Search integration

When a user types in a search term and switches to the search center, the search results are preceded by a summary from the chatbot.

AI summary for search term "PDF layout" above the actual search results
Search center AI summary

Excluding pages as a data source

To exclude a page as a data source for the chatbot:

  1. Click the Options menu in the visual editor toolbar.
    Options menu of VisualEditor
    Page options menu
  2. Click Advanced settings.
  3. Click No, do not index after the label Can be indexed for ChatBot. Users can check this requirement in the visual editor toolbar under Options > Advanced options.

​This adds the behavior switch to the page source.

Configuration manager

An administrator can configure the name of the bot that is shown at the beginning of the chat window in the Config Manager under extension ChatBot.



PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end