Slack GPT

Slack GPT Bot

Dieses Repository enthält einen C#-basierten Slack-GPT-Bot, der das OpenAI-GPT-Modell verwendet, um die Fragen der Benutzer zu beantworten. Die Implementierung basiert auf Slack Sockets API, was bedeutet, dass der Bot nicht auf einem Server hosten muss. Der Bot kann auf jeder Maschine ausgeführt werden.

Hat dir dieses Tool gefallen? Geben Sie uns einen Besuch :) https://prographers.com//

Merkmale

• Integrieren Sie sich in die GPT-4 von OpenAI, um Fragen zu beantworten
• Behalten Sie den Konversationskontext in einem Thread -Format bei
• Integration der Socket -Modus mit Slack
• Teilt lange Nachrichten in mehrere Nachrichten auf und unterscheidet die Code -Block -Formatierung nicht
• Parameter zur Kontrolle des Verhaltens des Bots
• Docker -Unterstützung
• Vollständige Dokumentation
• Benutzerdefinierte vordefinierte und dynamische Befehle
• Kontext, eine Systemnachricht für den gesamten Thread -context

Abhängigkeiten

• .NET 8.0
• Openai
• Slacknet
• Slacknet.aspnetcore
• Octokit.net
• Newtonsoft.net
• Humanizer
• Litedb

OpenAI -API -Schlüssel bekommen

1. Gehen Sie zum Openai Dashboard
2. Klicken Sie auf die Schaltfläche "Neue Geheimschlüssel erstellen".
3. Kopieren Sie das Geheimnis und geben Sie es in die OpenAIKey -Variable in appsettings.json ein.

Hinweis: Die Verwendung der OpenAI -API erfordert ein bezahltes/Testkonto. Weitere Informationen zu Preisgestaltung finden Sie hier.

Berechtigungen in Slack konfigurieren

Bevor Sie den Slack GPT -Bot ausführen können, müssen Sie die entsprechenden Berechtigungen für Ihren Slack -Bot konfigurieren. Befolgen Sie diese Schritte, um die erforderlichen Berechtigungen einzurichten:

1. Erstellen Sie Slack App
2. Gehen Sie zu Ihrem Slack -API -Dashboard und klicken Sie auf die App, die Sie für diesen Bot erstellt haben.
3. Klicken Sie in der linken Seitenleiste auf "OAuth & Berechtigungen".
4. Im Abschnitt "Scopes" finden Sie zwei Arten von Scopes: "Bot Token Scopes" und "User Token Scopes". Fügen Sie die folgenden Bereiche unter "Bot Token Scopes" hinzu:
   • app_mentions:read : Ermöglicht dem Bot, erwähnte Ereignisse zu lesen.
   • chat:write : Ermöglicht dem Bot Nachrichten.
   • groups:history : Ermöglicht dem Bot, Nachrichten in privaten Kanälen zu lesen.
   • channels:history : Ermöglicht dem Bot, Nachrichten in öffentlichen Kanälen zu lesen.
   • Bitte beachten Sie, dass andere Berechtigungen je nach Standort des Bots erforderlich sein können.
5. Scrollen Sie zu den "OAuth -Token für Ihren Arbeitsbereich" und klicken Sie auf "App installieren Sie die App für den Arbeitsbereich". Dies erzeugt die SlackBotToken .
6. Klicken Sie in der linken Seitenleiste auf "Socket -Modus" und aktivieren Sie sie. Sie werden aufgefordert, "ein Token auf App-Ebene zu generieren, um den Socket-Modus zu aktivieren". Generieren Sie ein Token namens SlackAppToken und fügen Sie die connections:write den Bereich.
7. Klicken Sie auf dem Abschnitt "Offizier betroffen" auf der Seite "Socket -Modus" auf "Ereignisabonnements" und "Twoggle" aktivieren Ereignisse "to" on ". app_mention -Ereignis mit den app_mentions:read den Abschnitt "Abonnieren von Bot -Ereignissen" unterhalb des Umschusses.

Verwendung

1. Führen Sie das Projekt aus

dotnet run --project Slack-GPT-Socket

Oder finden Sie #Docker, um weitere Informationen zum Hosting zu erhalten.

2. Laden Sie den Bot zu Ihrem gewünschten Slack -Kanal ein.
3. Erwähnen Sie den Bot in einer Nachricht und stellen Sie eine Frage. Der Bot wird mit einer Antwort antworten. Sie können den Bot im selben Thread weiter erwähnen, um das Gespräch fortzusetzen.

Sie können Ihre Nachricht mit dem Namen des Modells ohne Parameter z. B. starten:

@GPT-4 Turbo Wie geht es dir heute?

Verwendet GPT-3.5-Turbo anstelle des Standard-GPT-4-Modells. Weitere Aliase finden Sie in GPTClient.

Integrierte Parameter

Es gibt einige integrierte Parameter. Verwenden Sie /gpt help um sie zu sehen. Sie können die Parameter in appsettings.json -Datei oder pro Anforderung ändern.

Weitere Informationen zu den Standardeinstellungen oder appsettings.Example.json finden Sie unter gptdefaults.cs.

Benutzerdefinierte Parameter

Vordefinierte Befehle

Sie können Ihnen den Bot für benutzerdefinierte Parameter hinzufügen, um die Eingabe für jede abgegebene Anforderung zu minimieren. Fügen Sie dazu die IT -Definition in den Abschnitt GptCommands in appsettings.json hinzu. Zum Beispiel:

 "GptCommands" : {
    "Commands" :  [
      {
        "Command" : " -refactor " ,
        "Description" : " Tells GPT to refactor provided code " ,
        "Prompt" : " Given the following code, refactor it to be more readable and maintainable. Please provide code documentation for all members in the code and comments where appropriate. "
      },
      {
      "Command" : " -prographers " ,
      "Description" : " A command to add infomation about Prographers " ,
      "Prompt" : " Prographers is software-house company that specializes in 3D product configurators. Prographers exists since 2016 and currently hires around 20 people. Prographers solutions focus on Web applications that are used by companies to configure their products. Applications produced are focusing on high-quality graphics and design, resulting in great products that customers awe. Prographers is located in Warsaw, Poland. "
      }
  }

Verwendung:

@GPT -4 -PROBROPROREL Was wissen Sie über Prographen?

@Gpt -4 -refactor public class Foo { public void Bar() { Console.WriteLine("Hello World"); } }

Dynamische Befehle

In ähnlicher Weise können Sie dynamische Befehle erstellen. Rufen Sie dazu die /gpt commands add -command "prompt" "description" -global -Befehl mit dem Befehlsnamen und der Eingabeaufforderung hin.

• -command wie dieser Befehl aufgerufen wird. EG: -prographers
• -prompt die Eingabeaufforderung, die für diesen Befehl verwendet wird. EG: Prographers is software-house company...
• -description Die Beschreibung des Befehls. ZB: A command to add infomation about Prographers Dies ist optional.
• -global Flag wird den Befehl allen Benutzern zur Verfügung stellen. Andernfalls ist es für den Benutzer verfügbar, der es erstellt hat.

Verwenden Sie /gpt commands help um weitere Informationen über die Befehle anzuzeigen.

Docker

Sie können den Docker -Container mit dem folgenden Befehl starten:

docker run -v ./appsettings.json:/app/appsettings.json --restart always ghcr.io/prographers/slack-gpt:latest

Sie können auch die Datei docker-compose.yml verwenden, um den Container abzulösen. Docker Compose zieht das Bild automatisch aus der GitHub -Containerregistrierung und startet den Container, wenn dies geschieht. Es wird Wachtturm verwenden, um dies zu tun.

docker-compose up -d

Bitte denken Sie daran, die Datei appsettings.json in das gleiche Verzeichnis wie den Befehl für beide Fälle zu setzen.

Sicherheit

Beide Bilder werden an keiner Port aufgenommen und können von außen nicht zugegriffen werden. Die einzige Möglichkeit, auf den Container zuzugreifen, ist die Slack -API. Der Container wird auch als Nicht-Root-Benutzer ausgeführt und hat keinen Zugriff auf das Hostsystem.

Einschränkungen und Tipps

• Der Bot wird seine eigene Erwähnung aus der Nachricht ausziehen, sodass er nicht in der Eingabeaufforderung aufgenommen wird. Dies soll rekursive Anrufe verhindern.
• Der Bot antwortet nur auf Nachrichten, die mit seiner Erwähnung beginnen.
• Erwähnungen in Bot -Besitzkanälen werden ignoriert. (Könnte in Zukunft geändert werden.) Er muss zum Kanal eingeladen werden.
• Alle Befehle sind unempfindlich.
• Bot erstellt nur einen Thread aus Nachrichten, die mit seiner Erwähnung und seinen eigenen Nachrichten beginnen.
• Das Bearbeiten einer Nachricht löst eine neue Antwort aus, als ob eine neue Nachricht gesendet wurde.
• Bei der Bearbeitung einer Nachricht im Thread antwortet der Bot auf die bearbeitete Nachricht. Es wird jeden Thread ignorieren, der nach der bearbeiteten Nachricht erstellt wurde.
• Das Löschen einer Nachricht ist eine Möglichkeit, den Thread neu zu machen. Dann ist es einfacher, die Konversation bei der Bearbeitung der Nachricht zu verfolgen.
• Ephemerale Nachrichten, die vom Bot erzeugt werden, verschwinden, nachdem der Slack -Client nachgeladen wird. Sie können sie in Einstellungen deaktivieren.

Laufen Sie lokal aus der Quelle

• Klonen Sie das Repository

git clone https://github.com/Prographers/Slack-GPT.git
cd Slack-GPT

• Nuget -Pakete wiederherstellen

dotnet restore

Screenshot

Benachrichtigungsnachrichten!

---

Fadenunterstützung!

---

Fehlermeldungen!