openai discord

OpenAI Дискорд

Простой бот Discord, интегрирующий библиотеки OpenAI для ChatGPT и DALL-E, способный генерировать текст и изображения в разговорах Discord.
Изучите документацию »

Посмотреть демо · Сообщить об ошибке · Запросить функцию

Оглавление

1. О проекте
   • Скриншоты
   • Построен с
   • Пакеты
2. Начиная
   • Установка
3. Использование
   • Команды
   • Параметры
   • Встраивает
4. API команд
5. Дорожная карта
6. Содействие
7. Лицензия
8. Благодарности

О проекте

Aurora AI, ранее известная как «Aurora AI», представляет собой чат-бот Discord, использующий языковую модель GPT-3.5-Turbo от OpenAI. Созданный на основе discord.js, он генерирует ответы на ввод пользователя в диалоговом формате. Созданный для простоты, это отличный инструмент для изучения возможностей GPT-3.5-Turbo в Discord. Кроме того, он также поддерживает использование DALL-E, модели генерации изображений, также разработанной OpenAI, что позволяет создавать креативные изображения наряду с возможностями естественного языка.

Скриншоты

Изображения

(вернуться к началу)

Построен с

Пакеты

• дискорд.js
• дотенв
• фс-экстра
• openai-узел
• Уинстон

(вернуться к началу)

Начиная

Установка

1. Получите необходимые ключи API

   • ОпенАИ
   • Раздор
   
   

2. Клонировать репозиторий

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

3. Установить пакеты

   pnpm install

4. Добавьте ключи API в переменные среды.

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

5. Создать проект

   pnpm run build

6. Запустить двоичные файлы

   pnpm run start

(вернуться к началу)

Использование

После инициализации проекта просто добавьте бота на свой сервер и наслаждайтесь.

Команды

Команда	Параметры	Тип	Описание
/ping	ephimeral	embed-info	Пропингуйте бота, чтобы проверить, находится ли он в сети.
/about	ephimeral	embed-info	Получить информацию о боте
/help	ephimeral	embed-info	Получить список всех команд
/chat	question ephimeral	embed-response embed-request	Чат с ботом
/clear	amount	embed-info	Очистить историю чата с ботом
/image	prompt quantity size ephimeral	embed-response embed-request	Создайте изображение с помощью предоставленной подсказки

Параметры

Вариант	Команда	Необходимый	По умолчанию	Выбор	Описание
question	/chat	true	Никто	Никто	Вопрос, который следует задать боту
prompt	/image	true	Никто	Никто	Текст, из которого будет создано изображение
quantity	/image	false	1	1 до 10	Количество изображений для создания
size	/image	false	256x256	256x256 512x512 1024x1024	Размер создаваемого изображения
amount	/clear	false	100	1 до 100	Количество сообщений для очистки
ephimeral	/ping /about /help /chat /image	false	false	true false	Скрыть ответ от других пользователей

(вернуться к началу)

Встраивает

Бот использует разнообразный визуальный код для встраивания, расположенный в нижнем колонтитуле каждого сообщения. В следующей таблице описаны вставки и их цвета.

Нижний колонтитул	Цвет	Описание
embed-info	Аква	Системное сообщение от бота
embed-error	Красный	Сообщение об ошибке от бота
embed-response	Зеленый	Ответ бота с контентом, созданным ИИ
embed-request	Золото	Запрос пользователя

(вернуться к началу)

API команд

Вы можете добавить в проект новые команды, выполнив следующие действия:

1. Создайте новый файл в папке src/bot/commands с именем команды, которую вы хотите добавить (например, testCommand.ts ).
2. Напишите класс, расширяющий Command и реализующий все методы.
3. Ваша команда будет автоматически добавлена ​​в бот.

Пример команды:

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

(вернуться к началу)

Дорожная карта

• Интеграция Докера
  • Докерфайл
  • Докер Составление
• Интеграция с Дискордом
  • API ОТДЫХ
  • Слэш-команды
  • Текстовые каналы
    • Эфемерный (необязательно)
  • Прямые сообщения
    • Эфемерный (необязательно)
• Интеграция языковой модели
  • ГПТ-3,5
    • Чат
  • ГПТ-4
• Интеграция DALL-E
  • Генерация изображений
  • Редактирование изображений
• Контекстное удобство использования
  • Один пользователь
  • Несколько пользователей

Полный список предлагаемых функций (и известных проблем) см. в разделе «Открытые проблемы».

(вернуться к началу)

Содействие

Вклады — это то, что делает сообщество открытого исходного кода таким замечательным местом для обучения, вдохновения и творчества. Мы очень ценим любой ваш вклад.

Если у вас есть предложение, которое могло бы улучшить ситуацию, создайте форк репозитория и создайте запрос на включение. Также можно просто открыть задачу с тегом «улучшение». Не забудьте поставить проекту звезду! Еще раз спасибо!

1. Форкнуть проект
2. Создайте свою ветку функций ( git checkout -b feature/AmazingFeature )
3. Зафиксируйте свои изменения ( git commit -m 'Add some AmazingFeature' )
4. Нажмите на ветку ( git push origin feature/AmazingFeature )
5. Открыть запрос на включение

(вернуться к началу)

Лицензия

Распространяется по лицензии MIT. См. LICENSE для получения дополнительной информации.

(вернуться к началу)

Благодарности

• Отнил Дрю

(вернуться к началу)