openai discord

OpenAI Discord

Ein einfacher Discord-Bot, der OpenAI-Bibliotheken für ChatGPT und DALL-E integriert und in der Lage ist, Text und Bilder in Discord-Konversationen zu generieren.
Entdecken Sie die Dokumente »

Demo ansehen · Fehler melden · Funktion anfordern

Inhaltsverzeichnis

1. Über das Projekt
   • Screenshots
   • Gebaut mit
   • Pakete
2. Erste Schritte
   • Installation
3. Verwendung
   • Befehle
   • Optionen
   • Einbettet
4. Befehls-API
5. Roadmap
6. Mitwirken
7. Lizenz
8. Danksagungen

Über das Projekt

Früher bekannt als „Aurora AI“, ist Aurora AI ein Discord-Chatbot, der das Sprachmodell GPT-3.5-Turbo von OpenAI nutzt. Es wurde mit discord.js erstellt und generiert Antworten auf Benutzereingaben in einem Konversationsformat. Es ist auf Einfachheit ausgelegt und ein großartiges Tool, um die Funktionen von GPT-3.5-Turbo in Discord zu erkunden. Darüber hinaus unterstützt es auch die Verwendung von DALL-E, dem ebenfalls von OpenAI entwickelten Bildgenerierungsmodell, das es ihm ermöglicht, neben seinen natürlichen Sprachfähigkeiten auch kreative Bilder zu generieren.

Screenshots

Bilder

(zurück nach oben)

Gebaut mit

Pakete

• discord.js
• dotenv
• fs-extra
• OpenAI-Knoten
• Winston

(zurück nach oben)

Erste Schritte

Installation

1. Holen Sie sich die erforderlichen API-Schlüssel

   • OpenAI
   • Zwietracht
   
   

2. Klonen Sie das Repo

   git clone https://github.com/KrozT/openai-discord.git

3. Pakete installieren

   pnpm install

4. Fügen Sie die API-Schlüssel zu Ihren Umgebungsvariablen hinzu

    DISCORD_API_KEY = <YOUR DISCORD API KEY>
   OPENAI_API_KEY = <YOUR OPENAI API KEY>

5. Projekt erstellen

   pnpm run build

6. Binärdateien starten

   pnpm run start

(zurück nach oben)

Verwendung

Sobald Sie das Projekt initialisiert haben, fügen Sie einfach den Bot zu Ihrem Server hinzu und genießen Sie es.

Befehle

Befehl	Optionen	Typ	Beschreibung
/ping	ephimeral	embed-info	Pingen Sie den Bot, um zu prüfen, ob er online ist
/about	ephimeral	embed-info	Erhalten Sie Informationen über den Bot
/help	ephimeral	embed-info	Rufen Sie eine Liste aller Befehle ab
/chat	question ephimeral	embed-request embed-response	Chatten Sie mit dem Bot
/clear	amount	embed-info	Löschen Sie den Chatverlauf mit dem Bot
/image	prompt quantity size ephimeral	embed-request embed-response	Erstellen Sie mit der bereitgestellten Eingabeaufforderung ein Bild

Optionen

Option	Befehl	Erforderlich	Standard	Auswahlmöglichkeiten	Beschreibung
question	/chat	true	Keiner	Keiner	Die Frage, die man dem Bot stellen sollte
prompt	/image	true	Keiner	Keiner	Der Text, aus dem das Bild generiert werden soll
quantity	/image	false	1	1 bis 10	Anzahl der zu generierenden Bilder
size	/image	false	256x256	256x256 512x512 1024x1024	Größe des zu generierenden Bildes
amount	/clear	false	100	1 bis 100	Anzahl der zu löschenden Nachrichten
ephimeral	/ping /about /help /chat /image	false	false	true false	Verstecken Sie die Antwort vor anderen Benutzern

(zurück nach oben)

Einbettet

Der Bot verwendet verschiedene visuelle Einbettungscodes, die sich in der Fußzeile jeder Nachricht befinden. In der folgenden Tabelle werden die Einbettungen und ihre Farben beschrieben.

Fußzeile	Farbe	Beschreibung
embed-info	Aqua	Systemmeldung des Bots
embed-error	Rot	Fehlermeldung des Bots
embed-response	Grün	Antwort des Bots mit KI-generierten Inhalten
embed-request	Gold	Anfrage des Benutzers

(zurück nach oben)

Befehls-API

Sie können dem Projekt neue Befehle hinzufügen, indem Sie die folgenden Schritte ausführen:

1. Erstellen Sie im Ordner src/bot/commands eine neue Datei mit dem Namen des Befehls, den Sie hinzufügen möchten (z. B. testCommand.ts ).
2. Schreiben Sie eine Klasse, die den Command erweitert und alle Methoden implementiert.
3. Ihr Befehl wird automatisch zum Bot hinzugefügt.

Befehlsbeispiel:

 import { Command } from '@/bot/models/command' ;
import { Client , CommandInteraction } from 'discord.js' ;

export class TestCommand extends Command {
    public configure ( ) : void {
        this . setName ( 'test' ) ;
        this . setDescription ( 'Test command' ) ;
        this . addEphemeralOption ( ) ; // Add the ephemeral option to the command
    }

    protected async execute ( client : Client , interaction : CommandInteraction ) : Promise < void > {
        await interaction . reply ( { content : 'Test command executed' , ephemeral : this . ephermeral } ) ;
    }
}

(zurück nach oben)

Roadmap

• Docker-Integration
  • Docker-Datei
  • Docker Compose
• Discord-Integration
  • API-REST
  • Slash-Befehle
  • Textkanäle
    • Vergänglich (optional)
  • Direktnachrichten
    • Vergänglich (optional)
• Sprachmodellintegration
  • GPT-3.5
    • Chatten
  • GPT-4
• DALL-E-Integration
  • Bilderzeugung
  • Bildbearbeitung
• Kontextbasierte Benutzerfreundlichkeit
  • Einzelbenutzer
  • Mehrere Benutzer

Eine vollständige Liste der vorgeschlagenen Funktionen (und bekannten Probleme) finden Sie in den offenen Problemen.

(zurück nach oben)

Mitwirken

Beiträge machen die Open-Source-Community zu einem so wunderbaren Ort zum Lernen, Inspirieren und Schaffen. Jeder Beitrag, den Sie leisten, wird sehr geschätzt .

Wenn Sie einen Vorschlag haben, der dies verbessern könnte, forken Sie bitte das Repo und erstellen Sie eine Pull-Anfrage. Sie können ein Problem auch einfach mit dem Tag „Verbesserung“ eröffnen. Vergessen Sie nicht, dem Projekt einen Stern zu geben! Danke noch einmal!

1. Forken Sie das Projekt
2. Erstellen Sie Ihren Feature-Zweig ( git checkout -b feature/AmazingFeature )
3. Übernehmen Sie Ihre Änderungen ( git commit -m 'Add some AmazingFeature' )
4. Push to the Branch ( git push origin feature/AmazingFeature )
5. Öffnen Sie eine Pull-Anfrage

(zurück nach oben)

Lizenz

Verteilt unter der MIT-Lizenz. Weitere Informationen finden Sie unter LICENSE .

(zurück nach oben)

Danksagungen

• Othneil Drew

(zurück nach oben)