hugging face qa bot

Объятие вопросов о документации

Система вопросов и ответов с несколькими интерфейсами, которая использует LLM Hugging Face LLM и добыча добычи (RAG), чтобы доставить ответы на основе документации об объятиях лица. Работая как API, Discord Bot или приложение Gradio, оно также предоставляет ссылки на документацию, используемую для формулирования каждого ответа.

Пример

Оглавление

• Настройка
• Бег
  • Градио
  • API
  • Discord Bot
• Индексы
• Инструкции по разработке

Настройка

Чтобы выполнить любой из доступных интерфейсов, укажите необходимые параметры в файле .env на основе .env.example , расположенной в config/ каталоге. В качестве альтернативы, вы можете установить их как переменные среды:

• QUESTION_ANSWERING_MODEL_ID - (str) Строка, которая указывает либо идентификатор модели из концентратора обнимающего лица, либо каталог, содержащий веса модели
• EMBEDDING_MODEL_ID - (Str) ID модели встраивания из узла обнимающего лица. Мы рекомендуем использовать hkunlp/instructor-large
• INDEX_REPO_ID - (str) идентификатор репозитория из центра обнимающего лица, где хранится индекс. Список наиболее фактических индексов можно найти в этом разделе: индексы
• PROMPT_TEMPLATE_NAME - (str) Имя шаблона приглашения модели, используемого для ответа на вопросы, шаблоны хранятся в каталоге config/api/prompt_templates
• USE_DOCS_FOR_CONTEXT - (bool) Используйте полученные документы в качестве контекста для данного запроса
• NUM_RELEVANT_DOCS - (int) Количество документов, используемых для предыдущей функции
• ADD_SOURCES_TO_RESPONSE - (bool) включите источники полученных документов, используемых в качестве контекста для данного запроса
• USE_MESSAGES_IN_CONTEXT - (bool) Используйте историю чата для разговорного опыта
• DEBUG - (bool) предоставляет дополнительные журналы

Установите необходимые зависимости из файла требований:

pip install -r requirements.txt

Бег

Градио

После завершения всех шагов, как описано в разделе «Настройка», укажите переменную среды APP_MODE в качестве gradio и запустите следующую команду:

python3 app.py

API порция

По умолчанию API обслуживается по адресу http://0.0.0.0:8000 . Чтобы запустить его, выполните все шаги, описанные в разделе «Настройка», затем выполните следующую команду:

python3 -m api

Discord Bot

Чтобы взаимодействовать с системой в качестве бота -дискора, добавьте дополнительные необходимые переменные среды из раздела Discord bot в файле .env.example в config/ каталоге.

• DISCORD_TOKEN - (Str) API -ключ для приложения BOT
• QA_SERVICE_URL - (str) URL службы API. Мы рекомендуем использовать: http://0.0.0.0:8000
• NUM_LAST_MESSAGES - (int) Количество сообщений, используемых для контекста в разговорах
• USE_NAMES_IN_CONTEXT - (bool) включите имена пользователей в контексте разговора
• ENABLE_COMMANDS - (bool) Разрешить команды, например, очистка канала
• DEBUG - (bool) предоставляет дополнительные журналы

После завершения всех шагов запустите:

python3 -m bot

Чтобы организовать бота, обнимая места для лица, укажите переменную среды APP_MODE в качестве discord , и бот будет автоматически запускать из файла app.py

Список индексов

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

• Все обнимающие репозитории лица свыше 50 звезд - 512 -характерные куски
• Все обнимающие репозитории лица свыше 50 звезд - 812 -символьные куски

Инструкции по разработке

Мы используем Python 3.10

Чтобы установить все необходимые пакеты Python, запустите следующую команду:

pip install -r requirements.txt

Мы используем Pipreqsnb для генерации файла TEDS.TXT. Чтобы установить Pipreqsnb, запустите следующую команду:

pip install pipreqsnb

Чтобы сгенерировать файл reditions.txt, запустите следующую команду:

pipreqsnb --force .

Чтобы запустить модульные тесты, вы можете использовать следующую команду:

pytest -o " testpaths=tests " --noconftest