younited genaibots

GenaiBots-Projekt

Überblick

GenaiBots ist ein umfassendes Framework zur Automatisierung und Verwaltung von Interaktionen auf verschiedenen digitalen Plattformen. Es handelt sich in erster Linie um ein Unternehmenstool zur Integration generativer KI in betriebliche Prozesse über Medien wie Instant Messaging, E-Mails, Ticketing-Tools oder interne Tools. Durch den Einsatz fortschrittlicher KI und eines modularen Plugin-Systems ermöglicht es die Erstellung anspruchsvoller Betriebsabläufe und Interaktionsmodelle, die sowohl auf Unternehmen als auch auf Entwickler zugeschnitten sind.

Weitere Details im Wiki https://github.com/YounitedCredit/younited-genaibots/wiki Sie können hier auch mit dem dedizierten GPT chatten, wenn Sie Fragen zur Installation, Konfiguration und Entwicklung von GenaiBots haben: https://chatgpt. com/g/g-HGEDT9hA2-genaibots-assistant

Dieses Webclient-Beispiel funktioniert gut mit dem Framework, wenn Sie es schnell testen möchten: https://github.com/Pilosite/genaibot-basicweb-client

Hauptmerkmale

• KI-Verbesserungen : Integrieren Sie generative KI in den Kern von Interaktionen. Dies ermöglicht nicht nur die Generierung individueller KI durch Eingabeaufforderungen, sondern auch die Möglichkeit, Aktionen auszulösen und Prozesse mit einer schnellen Feedbackschleife zu verwalten.
• Benutzerdefinierte Aktionshandler : Erstellen Sie ganz einfach benutzerdefinierte Aktionen basierend auf bestimmten Auslösern und Bedingungen und rufen Sie diese direkt über Eingabeaufforderungen auf.
• Erweiterbare Plugin-Architektur : Erweitern Sie die Funktionalität oder integrieren Sie Dienste von Drittanbietern über Plugins und sorgen Sie so für Flexibilität und Erweiterbarkeit.
• Integration mit Unternehmenssystemen : Integrieren Sie generative KI nahtlos in die Kern-IT-Infrastruktur über einen Webserver oder einen Docker-Container. Dies ermöglicht die Verarbeitung und Verfolgung von Aufgaben, die von Bots in verschiedenen Kontexten (Messaging, Ticketing-Tools, E-Mails, benutzerdefinierte Anwendungen) ausgeführt werden.
• Dynamische Backend-Dienste : Integriert sich in verschiedene Backend-Dienste für die Datenverarbeitung und -speicherung, sodass sich das System an spezifische Unternehmensanwendungsfälle und -anforderungen anpassen kann.

Systemanforderungen

• Betriebssystem : Kompatibel mit Windows, MacOS und Linux.
• Python-Version : 3.8 oder höher.
• Zusätzliche Bibliotheken und Abhängigkeiten : In der Datei requirements.txt aufgeführt.

Installationsanleitung

1. Klonen Sie das Repository

   git clone https://github.com/YounitedCredit/younited-genaibots
   cd genaibots

2. Virtuelle Umgebung einrichten (empfohlen)

   python -m venv venv
   source venv/bin/activate  # On Windows use `venvScriptsactivate`

3. Abhängigkeiten installieren

   pip install -r requirements.txt

Konfiguration

Konfigurieren Sie die Anwendungseinstellungen, indem Sie die Datei config.yaml im config bearbeiten. Stellen Sie sicher, dass alle erforderlichen API-Schlüssel und Datenbankkonfigurationen korrekt festgelegt sind.

config.yaml

Die Datei config.yaml zentralisiert die Konfigurationseinstellungen für die GenaiBots-Anwendung. Hier sind einige wichtige Abschnitte und ihre Zwecke:

• BOT_CONFIG : Enthält Einstellungen im Zusammenhang mit dem Bot-Verhalten und den Debugging-Ebenen.

  • LOG_DEBUG_LEVEL : Definiert die Debug-Ebene für die Protokollierung.
  • PROMPTS_FOLDER , CORE_PROMPT , MAIN_PROMPT , SUBPROMPTS_FOLDER : Geben Sie die Verzeichnisse und Dateien für Eingabeaufforderungen an.
  • SHOW_COST_IN_THREAD : Schalten Sie um, um Kosteninformationen in Threads anzuzeigen.
  • Hier werden auch verschiedene Standardnamen und Verhaltensweisen für Plugins konfiguriert.

• UTILS : Enthält Dienstprogrammkonfigurationen, z. B. Protokollierungseinstellungen.

  • LOGGING : Konfiguriert die Protokollierung, einschließlich Dateisystempfaden und Azure-Einstellungen.

• PLUGINS : Definiert verfügbare Plugins und deren Konfigurationen.

  • Zu den Kategorien gehören ACTION_INTERACTIONS , BACKEND , USER_INTERACTIONS , GENAI_INTERACTIONS und USER_INTERACTIONS_BEHAVIORS .

Umgebungseinrichtung

Die Umgebungsvariablen werden über python-dotenv geladen, normalerweise aus einer .env Datei. Dadurch kann die Anwendung vertrauliche Daten wie API-Schlüssel und Datenbank-URLs sicher laden. Hier ist ein grundlegender Überblick darüber, wie die Umgebungseinrichtung in GenaiBots funktioniert:

1. Umgebungsvariablen laden : Die Funktion load_dotenv() wird aufgerufen, um Umgebungsvariablen aus einer .env Datei in die Anwendung zu laden.
2. Zugriff auf Umgebungsvariablen : Die Konfigurationseinstellungen in config.yaml können diese Umgebungsvariablen mithilfe der $(ENV_VAR_NAME) -Syntax referenzieren.

Ausführen der Anwendung

Führen Sie den folgenden Befehl im Projektstammverzeichnis aus:

python app.py

Dadurch wird der Server gestartet und mit der Bearbeitung von Anfragen basierend auf konfigurierten Aktionen und Auslösern begonnen.

Debuggen in Visual Studio Code

Um die Anwendung in Visual Studio Code zu debuggen, verwenden Sie den folgenden Befehl:

c: ; cd ' c:reposYuc.GenaiBots ' ; & ' C:Users<your profile>miniconda3python.exe ' ' c:Users<your profile>.vscodeextensionsms-python.debugpy-2024.6.0-win32-x64bundledlibsdebugpyadapter/../..debugpylauncher ' ' 64580 ' ' -- ' ' -m ' ' uvicorn ' ' app:app ' ' --host ' ' localhost ' ' --port ' ' 7071 ' ' --workers ' ' 1 ' 

Plugin-Architektur

GenaiBots verwendet eine modulare Plugin-Architektur, die in mehrere Familien kategorisiert ist:

1. Aktionsinteraktionen :

   • Standard-Plugins : Vordefinierte Aktionen für allgemeine Aufgaben.
   • Benutzerdefinierte Plugins : Benutzerdefinierte Aktionen, die auf spezifische Bedürfnisse zugeschnitten sind.

2. Backend :

   • Verwaltet die interne Datenverarbeitung und Interaktionen mit Backend-Diensten.

3. Benutzerinteraktionen :

   • Instant Messaging : Plugins für den Umgang mit Messaging-Plattformen wie Slack und Teams.
   • Benutzerdefinierte API : Plugins zur Interaktion mit benutzerdefinierten APIs.

4. GenAI-Interaktionen :

   • Text : Plugins zum Generieren und Bearbeiten von Textinteraktionen mithilfe von KI.
   • Bild : Plugins zur Generierung und Handhabung von Bildinteraktionen mithilfe von KI.
   • Vektorsuche : Plugins zur Handhabung von Vektorsuchfunktionen.

5. Verhalten bei Benutzerinteraktionen :

   • Definiert das Verhalten von Benutzerinteraktionen über verschiedene Messaging-Plattformen und benutzerdefinierte APIs hinweg.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – weitere Einzelheiten finden Sie in der Datei LICENSE.md .

Support und Kontakt

Bei Supportanfragen oder zum Melden von Problemen besuchen Sie bitte unsere GitHub-Problemseite unter: https://github.com/YounitedCredit/younited-genaibots/issues