Wiki source code of KI Chatbot

Last modified by Anna Paul-Hasenfuss on 26.10.2026

Hide last authors
Carina Enke 33.7 1 {{display reference="LMS._Include Library.Allgemeine Infoseiten.Verfügbar mit Release 2026\.11\.x.WebHome"/}}
2
Carina Enke 7.1 3 {{section}}
4 {{column width="60%"}}
Carina Enke 36.1 5 [[image:KB_KI Chatbot.png||data-xwiki-image-style="img-icon" height="24" width="24"]] The **AI Chatbot **course module enables you to provide learners with an AI-powered chat assistant within the course itself. Learners can ask questions and receive real-time answers generated by a language model. The chatbot can also work with a set of knowledge resources (PDF materials) that you have provided, ensuring that the answers are based on your content.
Carina Enke 1.1 6
Carina Enke 7.1 7 {{gallery}}
Carina Enke 1.1 8
Carina Enke 12.1 9 [[image:Kursansicht - Chatbot mit Willkommenstext_de.png]]
10 [[image:Kursansicht - Beispiel Chatverlauf_de.png]]
Carina Enke 22.1 11 [[image:Kursansicht - Beispiel Chatverlauf2_de.png]]
Carina Enke 12.1 12 [[image:Kurseitor - Beispiel Konfiguration_de.png]]
Carina Enke 23.1 13 [[image:Kurseitor - Beispiel Konfiguration2_de.png]]
Carina Enke 7.1 14
15 {{/gallery}}
16 {{/column}}
17
18 {{column width="30%"}}
Carina Enke 36.1 19 {{panel title="Content"}}
Carina Enke 7.1 20 {{toc depth="3" start="2"/}}
21 {{/panel}}
22
Carina Enke 36.1 23 {{panel title="Related Topics"}}
24 * [[How to assign an AI connection>>doc:LMS.Benutzerhandbuch OPAL.Meine Lernplattform.Meine Einstellungen.KI-Anbindung im Profil hinterlegen.WebHome]]
Carina Enke 7.1 25 {{/panel}}
26
27
28 {{/column}}
29 {{/section}}
30
Carina Enke 8.1 31
32
Carina Enke 36.1 33 **Key functions:**
Carina Enke 1.1 34
Carina Enke 36.1 35 * Chatting with an AI language model (various providers/models can be configured)
36 * Answers are generated in real time and can be stopped at any time
37 * Optional: Responding to questions based solely on stored materials (RAG – knowledge index)
38 * Welcome text to greet learners and explain the chatbot’s role
39 * Consent Statement (data protection) before first use
40 * Exportable chat history (TXT, JSON, PDF, Markdown – depending on the installation)
41 * Copyable single questions and answers
42 * Display of token usage and the used model
Carina Enke 1.1 43
Carina Enke 36.1 44 **For advanced users:**
Carina Enke 5.1 45
Carina Enke 36.1 46 * System prompt to control AI behaviour (e.g. role, tone of voice, restrictions)
47 * Knowledge index derived from PDF materials in the course folder
48 * Management of visibility and access via conditions
49 * Assignment of a personal AI connection (API key), including billing via the key owner
Carina Enke 5.1 50
51
52
53
Carina Enke 36.1 54 == Course element view for learners ==
Carina Enke 1.1 55
Carina Enke 36.1 56 Once the Consent Statement for the chatbot has been accepted, learners see the chat interface’s home page with the configured welcome text.
Carina Enke 1.1 57
Carina Enke 13.1 58 [[image:Kursansicht - Leerer Chat_de.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
59
Carina Enke 36.1 60 === What learners can do ===
Carina Enke 1.1 61
Carina Enke 36.1 62 * Using the chatbot: asking questions, tracking answers, following up
63 * Exporting the chat history
64 * Copying individual questions and answers
Carina Enke 1.1 65
Carina Enke 36.1 66 Further information on these functions is available on the page [[Using the AI Chatbot>>doc:.Workflows.KI Chatbot verwenden.WebHome]].
Carina Enke 7.1 67
68
Carina Enke 36.1 69 == Course element view in the course editor ==
Carina Enke 1.1 70
Carina Enke 36.1 71 The H5P Content course element is integrated and configured via the course editor. The following sections are available:
Carina Enke 1.1 72
Carina Enke 36.1 73 * [[Title and description>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Kursbausteine.KI Chatbot.Konfiguration .Titel und Beschreibung.WebHome]]
74 * [[Visibility>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Kursbausteine.KI Chatbot.Konfiguration .Sichtbarkeit .WebHome]]
75 * [[Access>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Kursbausteine.KI Chatbot.Konfiguration .Zugang .WebHome]]
76 * [[Configuration>>doc:.Konfiguration .Konfiguration.WebHome]]
77 * [[Knowledge and Data>>doc:.Konfiguration .Wissen und Daten.WebHome]]
78 * [[Conditions>>doc:.Konfiguration .Bedingungen.WebHome]]
79 * [[Multilingualism>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Kursbausteine.KI Chatbot.Konfiguration .Mehrsprachigkeit .WebHome]]
Carina Enke 1.1 80
Carina Enke 25.1 81 [[image:Kurseitor - Leerer KB KI Chatbot_de.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
Carina Enke 1.1 82
83
84 === Workflows ===
85
Carina Enke 36.1 86 The following guides will help you to work with the **AI Chatbot**:
Carina Enke 1.1 87
Carina Enke 36.1 88 * [[Assign an AI connection to a profile>>doc:LMS.Benutzerhandbuch OPAL.Meine Lernplattform.Meine Einstellungen.KI-Anbindung im Profil hinterlegen.WebHome]] - setting up an AI connection from an available provider
89 * [[Assign an AI connection to a course element>>doc:.Konfiguration .Konfiguration.WebHome]] - select the connection you have set up and specify a model
90 * [[Add materials>>doc:.Konfiguration .Wissen und Daten.WebHome]] - assign PDF files from the course storage folder or upload new ones and index them
91 * [[Configure a system prompt and welcome text>>doc:.Konfiguration .Konfiguration.WebHome]] - define the AI behaviour and the welcome text
Carina Enke 11.1 92
93
94
Carina Enke 36.1 95 === Course element preview ===
Carina Enke 1.1 96
Carina Enke 36.1 97 The display of the embedded resource is the same for learners and course owners. If visibility or access restrictions have been applied, a preview is possible via the [[Learner view>>doc:LMS.Benutzerhandbuch OPAL.Lehren.Kurs.Lernendensicht.WebHome]].
Carina Enke 1.1 98
Carina Enke 28.1 99 [[image:Kursansicht - Vorschau in der Lernendensicht_de.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
Carina Enke 11.1 100
Carina Enke 1.1 101 ----
102
Carina Enke 36.1 103 == Use cases ==
Carina Enke 1.1 104
Carina Enke 36.1 105 * **AI-powered learning assistant:** Answering questions about the course content based on a knowledge index drawn from lecture notes and slides.
106 * **Exercise and revision tool:** Learners ask questions on a topic and receive immediate feedback.
107 * **Provision of additional information:** The chatbot supplements the course material with explanations, examples or further details based on stored additional information.
Carina Enke 1.1 108
Carina Enke 36.1 109 This section contains examples of use cases for this course element. If you would like to help us by providing a relevant example from your own work experience, please send us an email to [[support@bps-system.de>>mailto:support@bps-system.de]] with the subject line ‘**Practical example for the manual**’ and a few brief details about the use case and the configuration you have chosen.