Dieser Leitfaden erklärt, wie Sie benutzerdefinierte KI-Tools innerhalb des Discourse AI-Plugins erstellen, konfigurieren und integrieren, damit Administratoren die Fähigkeiten des Bots mit benutzerdefinierten JavaScript-Funktionen erweitern können.
Erforderliche Benutzerebene: Administrator
Tools sind programmierbare Funktionalitäten, die vom KI-Bot verwendet werden können, um bestimmte Aufgaben auszuführen oder Informationen abzurufen, die über reine textbasierte Antworten hinausgehen. Diese Tools sind Skripte oder Integrationen, die es dem Bot ermöglichen, mit externen APIs zu interagieren, Daten zu manipulieren oder zusätzliche Funktionen auszuführen, um seine Fähigkeiten zu erweitern.
Zusammenfassung
Diese Dokumentation behandelt:
- Erstellen eines neuen benutzerdefinierten KI-Tools
- Konfigurieren von Tool-Parametern und Skripten
- Verfügbare APIs für Tool-Skripte
- Integrieren benutzerdefinierter Tools mit KI-Personas
- Testen und Beheben von Problemen mit benutzerdefinierten Tools
Erstellen eines neuen benutzerdefinierten KI-Tools
So erstellen Sie ein neues KI-Tool:
- Navigieren Sie zum Admin-Panel > Plugins > Discourse AI > Tools.
- Klicken Sie auf „Neues Tool“ (Sie können vorhandene Voreinstellungen verwenden, um sich über Optionen zu informieren).
- Füllen Sie die folgenden Felder aus:
- Name: Der Name des Tools, wie er der LLM präsentiert wird.
- Beschreibung: Die Beschreibung des Tools, wie sie der LLM präsentiert wird.
- Zusammenfassung: Zusammenfassung dessen, was das Tool zur Unterstützung der Benutzer tut (wird in den Details angezeigt).
- Parameter: Definieren Sie die Eingaben, die Ihr Tool benötigt, wie sie der LLM präsentiert werden.
- Skript: Der JavaScript-Code, der Ihr Tool antreibt.
- Klicken Sie auf „Speichern“.
Konfigurieren von Tool-Skripten
Verfügbare APIs
Ihre Tool-Skripte haben Zugriff auf die folgenden APIs:
-
HTTP-Anfragen:
http.get(url, options) http.post(url, options)Verwenden Sie diese, um mit externen Diensten zu interagieren. Sie können
optionsverwenden, um HTTP-Header anzugeben:http.get(url, { headers: { Auth: "some value" } }) http.post(url, { headers: { Auth: "some value", body: "some body" } }) http.patch(url, { headers: { Auth: "some value", body: "some body" } }) http.delete(url, { headers: ...}) http.put(url, { headers: ... , body: ...}) -
LLM (Sprachmodell)-Integration:
llm.truncate(text, length)Dies ermöglicht es Ihnen, Text innerhalb der Token-Limits des KI-Modells zu bearbeiten.
-
Benutzerdefinierte Upload-Integration (RAG)
index.search(query, { filenames: options, limit: max_fragments_optional }) -
Unterstützung für die Erstellung von Uploads
upload.create(filename, base_64_content) -
Steuerung der Ausführungskette
chain.setCustomRaw(raw) - setzt den Body des Posts in der Kette.
Erforderliche Funktionen
Ihr Skript muss Folgendes implementieren:
invoke(params): Die Hauptfunktion, die ausgeführt wird, wenn das Tool aufgerufen wird.
Es kann optional Folgendes implementieren:
details(): (Optional) Bietet zusätzliche Informationen zur Ausführung des Tools.
Beispielskript:
function invoke(params) {
let result = http.get("https://api.example.com/data?query=" + params.query);
return JSON.parse(result.body);
}
function details() {
return "Fetched data from Example API";
}
Einschränkungen und Sicherheit
- Ausführungszeitlimit: Tools haben ein Standard-Zeitlimit von 2 Sekunden.
- HTTP-Anfragen: Maximal 20 Anfragen pro Tool-Ausführung.
- Abgeschottete Umgebung: Kein Zugriff auf das Server-Dateisystem oder Ruby-Bibliotheken.
Testen Ihres Tools
Sie sollten jedes von Ihnen erstellte Tool testen, um sicherzustellen, dass die Ergebnisse, die der LLM erhält, Ihren Erwartungen entsprechen.
Integration von Tools mit KI-Personas
So fügen Sie Ihr benutzerdefiniertes Tool zu einer KI-Persona hinzu:
- Gehen Sie zu Admin-Panel > Plugins > Discourse AI > Personas.
- Bearbeiten Sie eine vorhandene Persona oder erstellen Sie eine neue.
- Im Abschnitt „Tools“ sehen Sie Ihre benutzerdefinierten Tools neben den integrierten Tools aufgelistet.
- Wählen Sie Ihr benutzerdefiniertes Tool aus, um es zur Persona hinzuzufügen.
Benutzerdefinierte Tools in Aktion
Sobald Sie dem LLM das benutzerdefinierte Tool zur Verfügung stellen, kann es dieses zur Verbesserung der Konversation nutzen.
Fehlerbehebung
Wenn Ihr Tool nicht wie erwartet funktioniert:
- Verwenden Sie die Testoberfläche, um sicherzustellen, dass es für Ihre Eingaben wie erwartet funktioniert.
- Stellen Sie sicher, dass Ihre Gruppe in
ai_bot_debugging_allowed_groupsenthalten ist. Mitglieder dieser Gruppe haben vollen Zugriff auf die Bot-Transkripte; Sie können die KI-Protokolle dort einsehen. - Wenn etwas Unerwartetes passiert, besuchen Sie
https://SITENAME/logs, um nach Fehlern zu suchen.