RAGAI – Die globale Bot-API
RAGAI ist das zentrale JavaScript-Objekt, das dir als Bot-Entwickler zur Verfügung steht. Es wird automatisch im Bot-Kontext bereitgestellt und enthält alle Module, Hilfsfunktionen und Services, die du für die Entwicklung interaktiver Bots benötigst.
Zugriff
Du kannst RAGAI direkt im Bot-Code verwenden – es ist als globale Variable auf window verfügbar:
// Beide Varianten sind gleichwertig
const ragai = window.RAGAI;
const ragai2 = RAGAI;
tip
In jedem Bot-Skill, jeder Nachricht und jedem Code-Baustein steht dir RAGAI automatisch zur Verfügung. Du musst es nicht importieren oder initialisieren.
Lifecycle
Wenn ein Bot geladen wird, durchläuft RAGAI folgenden Lebenszyklus:
- Initialisierung – Das RAGAI-Objekt wird erstellt und alle Module werden registriert.
- initialIdle – Der Bot befindet sich im Leerlauf und wartet auf die ersten Nachrichten. Du kannst mit
RAGAI.initialMessages()auf die initialen Nachrichten warten. - Interaktion – Der Nutzer interagiert mit dem Bot. Du kannst auf Events reagieren, Nachrichten senden und Module nutzen.
// Warte auf die initialen Nachrichten des Bots
await RAGAI.initialMessages();
// Jetzt kannst du sicher auf den Bot-Zustand zugreifen
console.log("Bot ist bereit!");
Erste Schritte
Ein einfaches Beispiel, das eine Nachricht sendet und auf ein Event reagiert:
// Nachricht an den Bot senden
await RAGAI.MSG.prompt("Hallo Bot!");
// Auf ein Event lauschen
RAGAI.EVENTS.on("message", (msg) => {
console.log("Neue Nachricht:", msg);
});
// Eine Variable für eigene Daten nutzen
RAGAI.VARIABLES.meinWert = 42;
// Confetti als visuelles Feedback
RAGAI.confetti();
Verfügbare Module
Die folgende Tabelle listet alle Module und Funktionen auf, die dir über RAGAI zur Verfügung stehen:
Kommunikation & Nachrichten
| Modul | Beschreibung | Doku |
|---|---|---|
MSG | Nachrichten senden, empfangen und verwalten | MSG |
EVENTS | Event-System zum Reagieren auf Bot-Ereignisse | Events |
PROMPTBAR | Steuerung der Eingabeleiste | Promptbar |
BEFORE_SEND | Hooks vor dem Senden einer Nachricht | Before Send |
CHAT_AVATAR | Chat-Avatar konfigurieren | Chat Avatar |
VIDEO_AVATAR | Video-Avatar steuern | Video Avatar |
Daten & Speicher
| Modul | Beschreibung | Doku |
|---|---|---|
KEYVAL | Key-Value-Speicher (nutzerbezogen) | KeyVal |
PROJECTKEYVAL | Key-Value-Speicher (projektbezogen) | ProjectKeyVal |
DIALOGSTORE | Dialog-Verlauf speichern und laden | Dialogstore |
DOCSEARCH | Dokumentensuche durchführen | DocSearch |
UI & Darstellung
| Modul | Beschreibung | Doku |
|---|---|---|
STAGE | Bühne / Darstellungsbereich steuern | Stage |
OVERLAY | Overlay-Fenster anzeigen | Overlay |
CARDS | Karten-Darstellung | Cards |
CHARTS | Diagramme erstellen | Charts |
DOM | DOM-Manipulation im Bot-Kontext | DOM |
FUSIONVIEW | FusionView-Integration | FusionView |
KI & Generierung
| Modul | Beschreibung | Doku |
|---|---|---|
AITEXT_OPENAI | Textgenerierung mit OpenAI | AI Text OpenAI |
AITEXT_OLLAMA | Textgenerierung mit Ollama | AI Text Ollama |
AIIMAGE_OPENAI | Bildgenerierung mit OpenAI | AI Image OpenAI |
AIIMAGE_STABLEDIFFUSION | Bildgenerierung mit Stable Diffusion | AI Image SD |
Gamification & Interaktion
| Modul | Beschreibung | Doku |
|---|---|---|
SCORE | Punktestand verwalten | Score |
SKILL | Skill-System | Skill |
QUIZ | Quiz-Funktionalität | Quiz |
TRAIN | Trainingsmodus | Train |
SCORM | SCORM-Integration | SCORM |
Medien & Externe Dienste
| Modul | Beschreibung | Doku |
|---|---|---|
AUDIO | Audio-Wiedergabe und -Aufnahme | Audio |
YOUTUBE | YouTube-Videos einbetten | YouTube |
VIMEO | Vimeo-Videos einbetten | Vimeo |
MIRO | Miro-Board-Integration | Miro |
GAMMA | Gamma-Präsentationen generieren | Gamma |
ADOBECONNECT | Adobe Connect-Integration | Adobe Connect |
Hilfsfunktionen & Utilities
| Modul | Beschreibung | Doku |
|---|---|---|
HELPER | Allgemeine Hilfsfunktionen | Helper |
DOWNLOAD | Datei-Downloads auslösen | Download |
WAITFOR | Auf Bedingungen warten | WaitFor |
WEBHOOK | Webhooks aufrufen | Webhook |
MAIL | E-Mails versenden | |
LOG | Logging-Funktionen | Log |
INFO | Bot- und Projektinformationen | Info |
SUPERVISOR | Supervisor-Modus | Supervisor |
toastr | Toast-Benachrichtigungen anzeigen | Toastr |
Extras & Sonstiges
| Modul | Beschreibung | Doku |
|---|---|---|
FUNCTIONS | Leeres Objekt für eigene Funktionen | Extras |
VARIABLES | Leeres Objekt für eigene Variablen | Extras |
PARENT | Kommunikation mit dem übergeordneten iFrame | Extras |
BOTAPI | Bot-API für externe Kommunikation | Extras |
BOTMANAGER | Referenz auf den BotService | Extras |
DIALOGRECORDER | Dialog-Aufzeichnung | Extras |
confetti() | Konfetti-Animation | Extras |
cancel() | Denkprozess abbrechen | Extras |
chance() | Zufallsdaten-Bibliothek | Extras |
qs | QueryString-Bibliothek | Extras |
resetBot() | Bot zurücksetzen | Extras |
restartBot() | Bot neu starten | Extras |
runMessage() | Nachricht senden (deprecated) | Extras |
loggedInUser | Aktueller Nutzer | Extras |
lastThreadId | Letzte Thread-ID | Extras |
initialMessages() | Initiale Nachrichten | Extras |
service | RAGAI-Instanz | Extras |