ask discord

Спросите-разбирательство

Пылающий быстрый семантический поиск каналов раздора

Обзор

ask-discord позволяет пользователям семантически искать набор сообщений о Discord. Есть два основных режима поиска:

1. RAW : отображает наиболее похожие сообщения на основе сходства ANN и косинуса.
2. LLM : подает необработанные результаты в LLM для генерации ответа, подобного чатботу.

Начиная

Предварительные условия

• Докер
• OpenAI API -ключ
• Милвус 2.4.4
• Python 3.12.3

Установка

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

   git clone https://github.com/yourusername/ask-discord.git
   cd ask-discord

2. Установить зависимости :

   pip install -r requirements.txt

3. Установите переменные среды : создайте файл .env в корневом каталоге и добавьте свой клавиша API OpenAI:

    OPENAI_KEY = your_openai_api_key

4. Start Milvus : Следуйте руководству по установке Milvus, чтобы настроить и запустить Milvus. (Требует недавней установки Docker)

Запуск приложения

1. Сгенерируйте данные : загрузите ваши интересующие каналы, используя экспортер Chat Discord. Прочитайте это руководство, если у вас есть проблемы с получением идентификатора токена и каналов. Это не одобрение, так как каналы загрузки могут нарушать Discord TOS.

2. Загрузите данные : убедитесь, что файл данных JSON находится в правильном пути, указанном в configs . При необходимости измените путь в основном файле.

3. Запустите приложение Streamlit :

   streamlit run ask-discord.py

4. Доступ к приложению : Откройте свой веб -браузер и перейдите на http://localhost:8501 .

Документация

Файлы проекта

• Ask-discord.py : основная точка входа в приложение Streamlit. Он инициализирует конфигурации, подключается к Milvus и Openai и устанавливает базу данных и чат -бот.
• load_data.py : обрабатывает загрузку и обработку данных JSON Discord и управляет коллекцией Milvus.
• Chatbot.py : содержит класс Chatbot , который обрабатывает запросы Milvus и взаимодействие с режимом Raw/LLM.

Конфигурация

Конфигурации управляются через словарь в ask-discord.py . К ним относятся:

• OPENAI_CLIENT : экземпляр клиента Openai.
• CHAT_MODEL : модель для использования для чата (например, gpt-4o ).
• EMBEDDING_MODEL : модель для использования для генерации встраиваний.
• JSON_DATA_PATH : Путь к файлу данных JSON.
• EMBEDDING_DIMENSIONS : векторные размеры.
• MAX_MESSAGE_LENGTH : максимальное количество символов в сообщении, которое нужно учитывать.
• MIN_MESSAGE_LENGTH : минимальное количество символов в сообщении, которое нужно учитывать.
• COLLECTION_NAME : имя коллекции Milvus.
• MAX_SIMILAR_EXAMPLES : максимальное количество аналогичных сообщений для извлечения.
• SIMILARITY_SCORE_CUTOFF : отсечка для оценки сходства.

Внося

Взносы приветствуются! Пожалуйста, отправьте запрос на привлечение или откройте вопрос, чтобы обсудить любые изменения.

Лицензия

Этот проект лицензирован по лицензии MIT. Смотрите файл лицензии для получения более подробной информации.

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

• Экспортер чата