openai discord

Discorde OpenAI

Un simple bot Discord intégrant les bibliothèques OpenAI pour ChatGPT et DALL-E, capable de générer du texte et des images dans les conversations Discord.
Explorer les documents »

Voir la démo · Signaler un bug · Demander une fonctionnalité

Table des matières

1. À propos du projet
   • Captures d'écran
   • Construit avec
   • Forfaits
2. Commencer
   • Installation
3. Usage
   • Commandes
   • Possibilités
   • Intégrations
4. API de commandes
5. Feuille de route
6. Contribuer
7. Licence
8. Remerciements

À propos du projet

Anciennement connu sous le nom de « Aurora AI », Aurora AI est un chatbot Discord qui utilise le modèle de langage GPT-3.5-Turbo d'OpenAI. Construit avec discord.js, il génère des réponses aux entrées de l'utilisateur dans un format conversationnel. Conçu dans un souci de simplicité, c'est un excellent outil pour explorer les capacités de GPT-3.5-Turbo dans Discord. De plus, il prend également en charge l'utilisation de DALL-E, le modèle de génération d'images également développé par OpenAI, lui permettant de générer des images créatives parallèlement à ses capacités en langage naturel.

Captures d'écran

Images

(retour en haut)

Construit avec

Forfaits

• discord.js
• dotenv
• fs-extra
• nœud openai
• Winston

(retour en haut)

Commencer

Installation

1. Obtenez les clés API nécessaires

   • OpenAI
   • Discorde
   
   

2. Cloner le dépôt

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

3. Installer des packages

   pnpm install

4. Ajoutez les clés API à vos variables d'environnement

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

5. Construire un projet

   pnpm run build

6. Démarrer les binaires

   pnpm run start

(retour en haut)

Usage

Une fois le projet initialisé, ajoutez simplement le bot à votre serveur et profitez-en.

Commandes

Commande	Possibilités	Taper	Description
/ping	ephimeral	embed-info	Pingez le bot pour vérifier s'il est en ligne
/about	ephimeral	embed-info	Obtenir des informations sur le bot
/help	ephimeral	embed-info	Obtenez une liste de toutes les commandes
/chat	question ephimeral	embed-request embed-response	Discutez avec le bot
/clear	amount	embed-info	Effacer l'historique des discussions avec le bot
/image	quantity prompt size ephimeral	embed-request embed-response	Générez une image avec l'invite fournie

Possibilités

Option	Commande	Requis	Défaut	Choix	Description
question	/chat	true	Aucun	Aucun	La question à poser au bot
prompt	/image	true	Aucun	Aucun	Le texte à partir duquel générer l’image
quantity	/image	false	1	1 à 10	Quantité d'images à générer
size	/image	false	256x256	256x256 512x512 1024x1024	Taille de l'image à générer
amount	/clear	false	100	1 à 100	Nombre de messages à effacer
ephimeral	/ping /about /help /chat /image	false	false	true false	Masquer la réponse des autres utilisateurs

(retour en haut)

Intégrations

Le bot utilise une variété de codes visuels intégrés situés dans le pied de page de chaque message. Le tableau suivant décrit les intégrations et leurs couleurs.

Pied de page	Couleur	Description
embed-info	Aqua	Message système du bot
embed-error	Rouge	Message d'erreur du bot
embed-response	Vert	Réponse du bot avec du contenu généré par l'IA
embed-request	Or	Demande de l'utilisateur

(retour en haut)

API de commandes

Vous pouvez ajouter de nouvelles commandes au projet en suivant ces étapes :

1. Créez un nouveau fichier dans le dossier src/bot/commands avec le nom de la commande que vous souhaitez ajouter (par exemple testCommand.ts ).
2. Écrivez une classe qui étend la Command et implémente toutes les méthodes.
3. Votre commande sera automatiquement ajoutée au bot.

Exemple de commande :

 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 } ) ;
    }
}

(retour en haut)

Feuille de route

• Intégration Docker
  • Fichier Docker
  • Docker Composer
• Intégration Discorde
  • API REST
  • Commandes barre oblique
  • Canaux de texte
    • Éphémère (facultatif)
  • Messages directs
    • Éphémère (facultatif)
• Intégration du modèle de langage
  • GPT-3.5
    • Chat
  • GPT-4
• Intégration DALL-E
  • Génération d'images
  • Édition d'images
• Utilisabilité basée sur le contexte
  • Utilisateur unique
  • Plusieurs utilisateurs

Consultez les problèmes ouverts pour une liste complète des fonctionnalités proposées (et des problèmes connus).

(retour en haut)

Contribuer

Les contributions sont ce qui fait de la communauté open source un endroit si formidable pour apprendre, inspirer et créer. Toutes les contributions que vous apportez sont grandement appréciées .

Si vous avez une suggestion pour améliorer les choses, veuillez créer le dépôt et créer une pull request. Vous pouvez aussi simplement ouvrir un ticket avec la balise « amélioration ». N'oubliez pas de donner une étoile au projet ! Merci encore!

1. Forkez le projet
2. Créez votre branche de fonctionnalités ( git checkout -b feature/AmazingFeature )
3. Validez vos modifications ( git commit -m 'Add some AmazingFeature' )
4. Pousser vers la branche ( git push origin feature/AmazingFeature )
5. Ouvrir une demande de tirage

(retour en haut)

Licence

Distribué sous licence MIT. Voir LICENSE pour plus d’informations.

(retour en haut)

Remerciements

• Othneil Drew

(retour en haut)