upsy

UPSY: Ihr neuer Kumpel bei Discord & Slack. Angetrieben von AI.

Notiz

Dieses Projekt ist ein Community -Projekt.

Das Projekt wird von der Community gepflegt und unterstützt. Upstash kann dazu beitragen, unterstützt aber offiziell die Verantwortung dafür.

UPSY ist ein Open Source Discord & Slack Bot, der schnelle, genaue Antworten gibt, wenn Sie eine Frage haben .

Wie benutze ich es?

• Erwähnen Sie UPSY in einer Frage innerhalb eines Kanals, und Upsy wird in einem Thread antworten.

• Wenn jemand eine Frage in einem Kanal stellt, reagieren Sie mit einem ❓ oder? Emoji. Upsy erstellt dann einen Thread und gibt eine Antwort.

• Stellen Sie die Fragen direkt in DM für sofortige Antworten.

• Lehren Sie Upsy neue Informationen, indem Sie Nachrichten senden oder Dokumente in DM hochladen.

upsy.mp4

Discord -Setup

Erstellen Sie eine Discord -Anwendung

Erstellen Sie eine Anwendung unter "https://discord.com/developers/applications".

Privilegierte Gateway -Absichten

Damit der Bot auf den Nachrichtenverlauf zugreifen kann, müssen Sie die Privileged Gateway Intents aktivieren. Gehen Sie zum Bot -Abschnitt Ihrer Discord -Anwendung und aktivieren Sie die MESSAGE CONTENT INTENT und SERVER MEMBERS INTENT .

Standardinstallationseinstellungen

Gehen Sie zu Einstellungen> Installation und prüfen Sie nur Guild Install (Deaktivieren Sie User Install ).

Nach der Auswahl der Installationsverbindung (Einstellungen> Installation) als Link zur vorliegenden Discord müssen Sie wie folgt die Einstellungen für die Standardinstallation von Scopes und Berechtigungen aktualisieren:

Scopes: Anwendungen.Commands, Bot

BOT -Berechtigungen: Nachrichten senden, Nachrichtenverlauf lesen, Kanäle anzeigen, Nachrichten in Threads senden.

Holen Sie sich Ihren Bot -Token

RETT -Token im Bot -Abschnitt Ihrer Discord -Anwendung. Ihr Token sollte mit "Mtizmz ..." beginnen. Sie können auch ein Symbol für Ihre Upsy -App festlegen.

Konfigurationsdatei

Klonen Sie den Ordner Discord und stellen Sie Ihr Token in config/config.json -Datei ein

{
    "client" : {
        "token" : " MTIzMz... " ,
    },
} 

Holen Sie sich Ihre Anwendungs ​​-ID und stellen Sie sie in config/config.json -Datei ein

Sie finden Ihre Bewerbungs -ID im Abschnitt Allgemeine Informationen Ihrer Discord -Bewerbung.

{
    "client" : {
		    "id" : " 123333333333333333 " ,
        "token" : " MTIzMz... " ,
    },
} 

Stellen Sie die Umgebungsvariablen entweder in DockerFile oder fly.toml fest:

Sie müssen Redis- und Vektor -Datenbanken aus Upstash erstellen

 OPENAI_API_KEY = " "
UPSTASH_REDIS_REST_TOKEN = " "
UPSTASH_REDIS_REST_URL = " "
UPSTASH_VECTOR_REST_TOKEN = " "
UPSTASH_VECTOR_REST_URL = " "

Sie können den Bot entweder lokal ausführen oder ihn für fly.io bereitstellen

Lokale Bereitstellung

docker build -f discord/Dockerfile -t upsy-discord .
docker run -d -p 3001:3001 upsy-discord

Fly.io -Bereitstellung

fly launch
fly deploy

Vergessen Sie nicht, fly scale count 1 auszuführen, um sicherzustellen, dass nur eine Instanz ausgeführt wird.

Fügen Sie den Bot Ihrem Discord -Server hinzu

Um den Bot zu Ihrem Discord -Server hinzuzufügen, müssen Sie eine OAuth2 -URL generieren. Gehen Sie zum Installationsabschnitt Ihrer Discord -Anwendung und wählen Sie unter Installationsverbindung den Link Discord bereitgestellt. Sie können dann den Bot zu Ihrem Server hinzufügen.

Zu diesem Zeitpunkt sollten Sie den Bot online in Ihrem Discord -Server sehen.

Slack Setup

Checkout Upsy Slack Dokumentation.

Anmerkungen:

Ihre anfänglichen Discord -Befehle werden bei Docker Build Time registriert. Um neue Befehle zu löschen, zu aktualisieren oder hinzuzufügen, müssen Sie npm run commands:* Befehle.

Die in diesem Projekt verwendete Discord-Vorlage lautet: Discord-Bot-Typ-Template

Beitragen

UPSY ist in Arbeit, daher werden wir mehr Funktionen hinzufügen und die aktuellen verbessern. Wir haben ein paar Ideen gesammelt, von denen wir glauben, dass sie einen noch hilfreicheren Begleiter ausmachen würden:

• Fügen Sie dem Kontext Dokumente hinzu, damit Upsy sie als Kontext auswendig lernen und verwenden kann.
• Fügen Sie eine Weboberfläche hinzu, um Upsy zu verwalten, damit Sie über die Weboberfläche neue Informationen zum Speicher von UPSY hinzufügen und das Verhalten von UpSy konfigurieren können
• Proaktiverer Upsy - Upsy leitet Gespräche mit Ihnen oder reagiert auf Begrüßung, Geburtstag usw. Nachrichten
• Fähigkeit, persönliche Charaktere für Aufwärtstrend zu wählen, wie freundlicher, lustiger oder ernster

Wenn eine dieser Ideen nach etwas klingt, an dem Sie arbeiten möchten, sind Beiträge sehr willkommen! Sie können dazu beitragen, neue Funktionen hinzuzufügen, Fehler zu beheben, die Dokumentation zu verbessern, Blog -Beiträge zu schreiben oder Upsy in sozialen Medien zu teilen.