Skip to main content

HELPER

Der HELPER-Service stellt verschiedene Hilfsfunktionen bereit, mit denen du z. B. das Browserfenster schließen, Text in die Zwischenablage kopieren, den Bot beenden oder Statistiken erfassen kannst.


.closeWindow()

Schließt das aktuelle Browserfenster. Funktioniert nur, wenn das Fenster per JavaScript geöffnet wurde.

RAGAI.HELPER.closeWindow();

.copyToClipboard(text)

Kopiert den übergebenen Text in die Zwischenablage des Nutzers.

ParameterTypBeschreibung
textstringDer Text, der in die Zwischenablage kopiert werden soll.
RAGAI.HELPER.copyToClipboard('Dieser Text wird kopiert');

.timeToSeconds(hours, minutes, seconds)

Rechnet eine Zeitangabe in Stunden, Minuten und Sekunden in die Gesamtzahl an Sekunden um.

ParameterTypBeschreibung
hoursnumberStunden.
minutesnumberMinuten.
secondsnumberSekunden.

Rückgabe: number – Die berechnete Gesamtzeit in Sekunden.

const sekunden = RAGAI.HELPER.timeToSeconds(1, 30, 0);
console.log(sekunden); // 5400

.endBot(opts?)

Beendet die Kommunikation mit dem Bot. Du kannst optional eine Abschlussnachricht, einen Titel und eine Weiterleitung konfigurieren.

ParameterTypPflichtBeschreibung
optsPartial<EndBotOptions>neinOptionale Konfiguration für das Bot-Ende.

EndBotOptions:

EigenschaftTypBeschreibung
messagestringNachricht, die dem Nutzer beim Beenden angezeigt wird.
titlestringTitel der Abschlussanzeige.
autoRedirectSecondsnumberSekunden bis zur automatischen Weiterleitung (0 = keine Weiterleitung).
redirectUrlstringURL, zu der der Nutzer weitergeleitet wird.
RAGAI.HELPER.endBot({
title: 'Vielen Dank!',
message: 'Das Gespräch wurde beendet.',
autoRedirectSeconds: 5,
redirectUrl: 'https://beispiel.de'
});
// Einfaches Beenden ohne Optionen
RAGAI.HELPER.endBot();

.addStat(stat)

Erfasst einen statistischen Messpunkt für die Bot-Analyse. Damit kannst du z. B. tracken, welche Aktionen der Nutzer durchgeführt hat.

ParameterTypBeschreibung
statstringBezeichnung des Messpunkts.

Rückgabe: Promise

await RAGAI.HELPER.addStat('Kontaktdaten erfragt');

.getImageURlFromSkill(skillId)

Gibt die URL eines im Bot hinterlegten Bildes anhand der Skill-ID zurück. Damit kannst du Bilder aus dem Bot dynamisch referenzieren.

ParameterTypBeschreibung
skillIdstringDie Skill-ID des Bildes.

Rückgabe: Promise<string> – Die URL zum Bild.

const imageUrl = await RAGAI.HELPER.getImageURlFromSkill('ChatBotAvatarImg');
console.log('Bild-URL:', imageUrl);