Skip to main content

Extras & Hilfsobjekte

Auf dieser Seite findest du alle zusätzlichen Funktionen und Eigenschaften, die direkt auf dem RAGAI-Objekt verfügbar sind und keinem eigenen Modul zugeordnet sind.


.confetti()

Stellt die canvas-confetti-Bibliothek bereit. Damit kannst du Konfetti-Animationen auslösen – ideal als visuelles Feedback bei Erfolgen, Quiz-Antworten oder Gamification.

// Einfacher Konfetti-Effekt
RAGAI.confetti();

// Mit Optionen
RAGAI.confetti({
particleCount: 150,
spread: 70,
origin: { y: 0.6 }
});

.cancel()

Bricht den aktuellen Denkprozess des Bots ab. Verwende diese Funktion, wenn du eine laufende KI-Anfrage stoppen möchtest, z. B. bei einem Timeout oder einer Nutzeraktion.

// Denkprozess abbrechen
await RAGAI.cancel();

.chance()

Stellt die Chance.js-Bibliothek bereit. Damit kannst du zufällige Daten generieren – Namen, E-Mail-Adressen, Zahlen, Texte und vieles mehr.

// Zufälligen Namen generieren
const name = RAGAI.chance.name();

// Zufällige Zahl zwischen 1 und 100
const zahl = RAGAI.chance.integer({ min: 1, max: 100 });

// Zufällige E-Mail-Adresse
const email = RAGAI.chance.email();

// Zufälliger Satz
const satz = RAGAI.chance.sentence();

.qs

Stellt die querystring-Bibliothek bereit. Damit kannst du URL-Query-Parameter parsen und erstellen.

// Query-String parsen
const params = RAGAI.qs.parse("name=Max&alter=25");
console.log(params.name); // "Max"

// Objekt zu Query-String konvertieren
const queryString = RAGAI.qs.stringify({ seite: 2, filter: "aktiv" });
console.log(queryString); // "seite=2&filter=aktiv"

.resetBot()

Setzt den Bot für den aktuellen Nutzer zurück, ohne die Seite neu zu laden. Alle Variablen, der Dialogverlauf und der Zustand werden zurückgesetzt. Nützlich, wenn du dem Nutzer einen „Neustart"-Button anbieten möchtest.

// Bot zurücksetzen (ohne Reload)
await RAGAI.resetBot();

.restartBot()

Setzt den Bot zurück und lädt ihn komplett neu. Dies entspricht einem vollständigen Neustart, inklusive Seitenreload.

// Bot komplett neu starten
await RAGAI.restartBot();

.service

Gibt die interne RAGAI-Service-Instanz zurück. Dies ist eine Referenz auf den zugrundeliegenden Angular-Service. Für fortgeschrittene Anwendungsfälle, bei denen du direkten Zugriff auf interne Methoden benötigst.

// RAGAI-Service-Instanz abrufen
const ragaiService = RAGAI.service;
caution

Der direkte Zugriff auf RAGAI.service ist für fortgeschrittene Nutzer gedacht. Verwende nach Möglichkeit die dokumentierten Module.


.loggedInUser

Gibt den aktuell eingeloggten Nutzer zurück. Enthält Informationen wie Metadaten und die Gast-ID. Nützlich, um den Bot-Dialog zu personalisieren oder nutzerabhängige Logik einzubauen.

// Nutzer-Objekt abrufen
const user = RAGAI.loggedInUser;

// Nutzer-Metadaten (z. B. Name, Rolle etc.)
const metadata = RAGAI.loggedInUser.metadata;

// Gast-ID des Nutzers
const guestId = RAGAI.loggedInUser.guestId;

// Beispiel: Begrüßung personalisieren
if (RAGAI.loggedInUser?.metadata?.name) {
await RAGAI.MSG.prompt(`Hallo ${RAGAI.loggedInUser.metadata.name}!`);
}

.lastThreadId

Gibt die ID des letzten Threads zurück. Nützlich, um den aktuellen Gesprächsthread zu identifizieren oder zu referenzieren.

// Letzte Thread-ID abrufen
const threadId = RAGAI.lastThreadId;
console.log("Aktueller Thread:", threadId);

.initialMessages()

Gibt ein Promise zurück, das aufgelöst wird, sobald die initialen Bot-Nachrichten geladen und angezeigt wurden. Verwende diese Funktion, um sicherzustellen, dass der Bot vollständig initialisiert ist, bevor du weiteren Code ausführst.

// Warten, bis die initialen Nachrichten geladen sind
await RAGAI.initialMessages();

// Jetzt ist der Bot bereit
console.log("Alle initialen Nachrichten wurden geladen.");

.runMessage(text) (deprecated)

Sendet eine Nachricht an den Bot. Diese Funktion ist veraltet – verwende stattdessen RAGAI.MSG.prompt().

// ❌ Veraltet
await RAGAI.runMessage("Hallo Bot");

// ✅ Verwende stattdessen
await RAGAI.MSG.prompt("Hallo Bot");
warning

runMessage() wird in zukünftigen Versionen entfernt. Migriere deinen Code zu RAGAI.MSG.prompt().