openai discord

Discordância OpenAI

Um simples bot Discord integrando bibliotecas OpenAI para ChatGPT e DALL-E, capaz de gerar texto e imagens em conversas Discord.
Explore os documentos »

Ver demonstração · Reportar bug · Solicitar recurso

Índice

1. Sobre o projeto
   • Capturas de tela
   • Construído com
   • Pacotes
2. Começando
   • Instalação
3. Uso
   • Comandos
   • Opções
   • Incorporações
4. API de comandos
5. Roteiro
6. Contribuindo
7. Licença
8. Agradecimentos

Sobre o projeto

Anteriormente conhecido como ‘Aurora AI’, Aurora AI é um chatbot Discord que utiliza o modelo de linguagem GPT-3.5-Turbo da OpenAI. Construído com discord.js, ele gera respostas às entradas do usuário em formato conversacional. Projetado para ser simples, é uma ótima ferramenta para explorar os recursos do GPT-3.5-Turbo no Discord. Além disso, também suporta o uso de DALL-E, modelo de geração de imagens também desenvolvido pela OpenAI, permitindo gerar imagens criativas juntamente com suas habilidades de linguagem natural.

Capturas de tela

Imagens

(voltar ao topo)

Construído com

Pacotes

• discord.js
• dotenv
• fs-extra
• nó openai
• Winston

(voltar ao topo)

Começando

Instalação

1. Obtenha as chaves de API necessárias

   • OpenAI
   • Discórdia
   
   

2. Clonar o repositório

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

3. Instalar pacotes

   pnpm install

4. Adicione as chaves de API às suas variáveis ​​de ambiente

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

5. Construir projeto

   pnpm run build

6. Iniciar binários

   pnpm run start

(voltar ao topo)

Uso

Depois de inicializar o projeto, basta adicionar o bot ao seu servidor e aproveitar.

Comandos

Comando	Opções	Tipo	Descrição
/ping	ephimeral	embed-info	Faça ping no bot para verificar se ele está online
/about	ephimeral	embed-info	Obtenha informações sobre o bot
/help	ephimeral	embed-info	Obtenha uma lista de todos os comandos
/chat	question ephimeral	embed-request embed-response	Converse com o bot
/clear	amount	embed-info	Limpe o histórico de bate-papo com o bot
/image	quantity prompt size ephimeral	embed-request embed-response	Gere uma imagem com o prompt fornecido

Opções

Opção	Comando	Obrigatório	Padrão	Escolhas	Descrição
question	/chat	true	Nenhum	Nenhum	A pergunta a ser feita ao bot
prompt	/image	true	Nenhum	Nenhum	O texto para gerar a imagem
quantity	/image	false	1	1 a 10	Quantidade de imagens a serem geradas
size	/image	false	256x256	256x256 512x512 1024x1024	Tamanho da imagem a ser gerada
amount	/clear	false	100	1 a 100	Quantidade de mensagens a serem limpas
ephimeral	/ping /about /help /chat /image	false	false	true false	Ocultar a resposta de outros usuários

(voltar ao topo)

Incorporações

O bot usa uma variedade de códigos visuais incorporados localizados no rodapé de cada mensagem. A tabela a seguir descreve as incorporações e suas cores.

Rodapé	Cor	Descrição
embed-info	Água	Mensagem do sistema pelo bot
embed-error	Vermelho	Mensagem de erro do bot
embed-response	Verde	Resposta do bot com conteúdo gerado por IA
embed-request	Ouro	Solicitação do usuário

(voltar ao topo)

API de comandos

Você pode adicionar novos comandos ao projeto seguindo estas etapas:

1. Crie um novo arquivo na pasta src/bot/commands com o nome do comando que deseja adicionar (por exemplo, testCommand.ts ).
2. Escreva uma classe que estenda o Command e implemente todos os métodos.
3. Seu comando será adicionado automaticamente ao bot.

Exemplo de comando:

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

(voltar ao topo)

Roteiro

• Integração Docker
  • Dockerfile
  • Composição do Docker
• Integração de discórdia
  • API REST
  • Comandos de barra
  • Canais de texto
    • Efêmero (opcional)
  • Mensagens Diretas
    • Efêmero (opcional)
• Integração de modelo de linguagem
  • GPT-3.5
    • Bater papo
  • GPT-4
• Integração DALL-E
  • Geração de imagem
  • Edição de imagem
• Usabilidade baseada em contexto
  • Usuário único
  • Vários usuários

Consulte os problemas em aberto para obter uma lista completa dos recursos propostos (e dos problemas conhecidos).

(voltar ao topo)

Contribuindo

As contribuições são o que tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada .

Se você tiver uma sugestão que possa melhorar isso, bifurque o repositório e crie uma solicitação pull. Você também pode simplesmente abrir um problema com a tag “aprimoramento”. Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!

1. Bifurque o projeto
2. Crie sua ramificação de recursos ( git checkout -b feature/AmazingFeature )
3. Confirme suas alterações ( git commit -m 'Add some AmazingFeature' )
4. Enviar para a filial ( git push origin feature/AmazingFeature )
5. Abra uma solicitação pull

(voltar ao topo)

Licença

Distribuído sob a licença MIT. Consulte LICENSE para obter mais informações.

(voltar ao topo)

Agradecimentos

• Othneil Drew

(voltar ao topo)