.BOTMANAGER
RAGAI.BOTMANAGER ist eine Referenz auf den internen BotService. Er bietet dir erweiterten Zugriff auf Bot-Verwaltungsfunktionen wie Statistiken, Feedback, Konfiguration und den Nachrichtenverlauf.
Der BOTMANAGER ist eine interne API und kann sich zwischen Versionen ändern. Verwende nach Möglichkeit die dokumentierten RAGAI-Module (MSG, HELPER, DIALOGSTORE etc.). Greife nur auf den BOTMANAGER zurück, wenn die Standard-Module nicht ausreichen.
Häufig genutzte Methoden
.scrollDown(scrollBehavior?)
Scrollt die Chat-Ansicht nach unten.
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
scrollBehavior | ScrollBehavior | 'smooth' | Art der Scroll-Animation |
await RAGAI.BOTMANAGER.scrollDown();
// Sofort scrollen (ohne Animation)
await RAGAI.BOTMANAGER.scrollDown('instant');
.addStat(botId, stat)
Fügt einen Messpunkt / eine Statistik für den Bot hinzu.
| Parameter | Typ | Beschreibung |
|---|---|---|
botId | string | Die Bot-ID |
stat | string | Der Messpunkt-Name |
await RAGAI.BOTMANAGER.addStat(RAGAI.service.botId, "quiz-gestartet");
Nutze bevorzugt RAGAI.HELPER.addStat('quiz-gestartet') – dort wird die Bot-ID automatisch gesetzt.
.getHistoryMessages(botId)
Gibt den vollständigen Nachrichtenverlauf des Bots zurück.
| Parameter | Typ | Beschreibung |
|---|---|---|
botId | string | Die Bot-ID |
Rückgabewert: Promise<{ messageHistory: HistoryItemResponse[] }>
const history = await RAGAI.BOTMANAGER.getHistoryMessages(RAGAI.service.botId);
console.log("Nachrichten:", history.messageHistory.length);
.resetBot(botId)
Setzt den Bot für den aktuellen Nutzer zurück.
| Parameter | Typ | Beschreibung |
|---|---|---|
botId | string | Die Bot-ID |
await RAGAI.BOTMANAGER.resetBot(RAGAI.service.botId);
Nutze bevorzugt RAGAI.resetBot() oder RAGAI.restartBot() – dort wird die Bot-ID automatisch gesetzt.
.getBotConfigAsUser(id)
Gibt die Bot-Konfiguration zurück, sofern der Nutzer Zugriff hat.
| Parameter | Typ | Beschreibung |
|---|---|---|
id | string | Die Bot-ID |
Rückgabewert: Promise<ChatbotConfig | null>
const config = await RAGAI.BOTMANAGER.getBotConfigAsUser(RAGAI.service.botId);
if (config) {
console.log("Bot-Name:", config.name);
}
.botConfig
Die aktuelle Bot-Konfiguration als Property.
const config = RAGAI.BOTMANAGER.botConfig;
console.log("Bot-Name:", config?.name);
console.log("Bot-ID:", config?._id);
Feedback-Methoden
.sendFeedback(feedbackId, feedback)
Sendet Nutzer-Feedback zu einer Bot-Nachricht.
await RAGAI.BOTMANAGER.sendFeedback(undefined, {
botId: RAGAI.service.botId,
messageId: "msg-123",
rating: 5,
comment: "Sehr hilfreiche Antwort!"
});
.getFeedback(botId)
Gibt alle Feedbacks für einen Bot zurück.
const result = await RAGAI.BOTMANAGER.getFeedback(RAGAI.service.botId);
console.log("Feedbacks:", result.feedbacks);
Weitere Methoden
| Methode | Beschreibung |
|---|---|
deleteHistoryMessages(botId, messageIds[]) | Löscht bestimmte Nachrichten aus dem Verlauf |
deleteHistoryItems(botId, { fromDate?, toDate? }) | Löscht Verlauf nach Zeitraum |
getHistoryInfo(botId) | Gibt Verlaufs-Statistiken zurück |
supervisorNotification(botId, historyItemId, messageName) | Benachrichtigt den Supervisor |
callWebhook(botId, skillId, data?) | Ruft einen Webhook auf |
sendBotThinkingCancel(botId, threadId) | Bricht den Denkprozess ab |
getDownloadableMaterial(botId, fileId) | Lädt eine Datei als ArrayBuffer |
getFileInformation(botId, skillId) | Gibt Datei-Infos zurück (Name, Typ, ID) |
getImageFromSkill(botId, skillId) | Gibt die Bild-URL eines Skills zurück |
Hinweise
- Die meisten Methoden benötigen die
botId. Du findest sie unterRAGAI.service.botId. - Für Standard-Anwendungsfälle nutze die spezialisierten Module:
RAGAI.MSG,RAGAI.HELPER,RAGAI.DIALOGSTORE,RAGAI.WEBHOOKetc.