hugging face qa bot

Memeluk sistem penjawab pertanyaan dokumentasi wajah

Sistem tanya jawab multi-antarmuka yang menggunakan LLM Hugging Face dan Retrieval Augmented Generation (RAG) untuk memberikan jawaban berdasarkan dokumentasi wajah pelukan. Dioperasikan sebagai aplikasi API, Discord Bot, atau Gradio, ini juga menyediakan tautan ke dokumentasi yang digunakan untuk merumuskan setiap jawaban.

Contoh

Daftar isi

• Menyiapkan
• Berlari
  • Gradio
  • API
  • Bot Perselisihan
• Indeks
• Instruksi pengembangan

Menyiapkan

Untuk menjalankan antarmuka yang tersedia, tentukan parameter yang diperlukan dalam file .env berdasarkan .env.example yang terletak di config/ direktori. Atau, Anda dapat mengatur ini sebagai variabel lingkungan:

• QUESTION_ANSWERING_MODEL_ID - (str) Sebuah string yang menentukan ID model dari hub wajah pelukan atau direktori yang berisi bobot model
• EMBEDDING_MODEL_ID - (str) ID model embedding dari hub wajah pemeluk. Kami merekomendasikan menggunakan hkunlp/instructor-large
• INDEX_REPO_ID - (str) ID repositori dari hub wajah pemeluk di mana indeks disimpan. Daftar indeks yang paling aktual dapat ditemukan di bagian ini: indeks
• PROMPT_TEMPLATE_NAME - (str) Nama templat prompt model yang digunakan untuk menjawab pertanyaan, templat disimpan dalam direktori config/api/prompt_templates
• USE_DOCS_FOR_CONTEXT - (bool) Gunakan dokumen yang diambil sebagai konteks untuk kueri yang diberikan
• NUM_RELEVANT_DOCS - (int) Jumlah dokumen yang digunakan untuk fitur sebelumnya
• ADD_SOURCES_TO_RESPONSE - (bool) termasuk sumber dokumen yang diambil yang digunakan sebagai konteks untuk kueri yang diberikan
• USE_MESSAGES_IN_CONTEXT - (bool) Gunakan riwayat obrolan untuk pengalaman percakapan
• DEBUG - (BOOL) menyediakan penebangan tambahan

Instal dependensi yang diperlukan dari file persyaratan:

pip install -r requirements.txt

Berlari

Gradio

Setelah menyelesaikan semua langkah seperti yang dijelaskan di bagian pengaturan, tentukan variabel lingkungan APP_MODE sebagai gradio dan jalankan perintah berikut:

python3 app.py

API melayani

Secara default, API disajikan di http://0.0.0.0:8000 . Untuk meluncurkannya, selesaikan semua langkah yang diuraikan di bagian pengaturan, lalu jalankan perintah berikut:

python3 -m api

Bot Perselisihan

Untuk berinteraksi dengan sistem sebagai bot Discord, tambahkan variabel lingkungan tambahan yang diperlukan dari bagian Discord bot dari file .env.example di config/ Directory.

• DISCORD_TOKEN - (str) kunci API untuk aplikasi bot
• QA_SERVICE_URL - (str) URL dari layanan API. Kami merekomendasikan menggunakan: http://0.0.0.0:8000
• NUM_LAST_MESSAGES - (int) Jumlah pesan yang digunakan untuk konteks dalam percakapan
• USE_NAMES_IN_CONTEXT - (bool) Sertakan nama pengguna dalam konteks percakapan
• ENABLE_COMMANDS - (bool) Izinkan perintah, misalnya, pembersihan saluran
• DEBUG - (BOOL) menyediakan penebangan tambahan

Setelah menyelesaikan semua langkah, jalankan:

python3 -m bot

Untuk meng -host bot pada ruang wajah memeluk, tentukan variabel lingkungan APP_MODE sebagai discord , dan bot akan dijalankan secara otomatis dari file app.py

Daftar Indeks

Daftar berikut berisi indeks terkini yang dapat digunakan untuk sistem:

• Semua pelukan pelukan lebih dari 50 bintang - potongan 512 -karakter
• Semua pelukan pelukan lebih dari 50 bintang - potongan 812 -karakter

Instruksi pengembangan

Kami menggunakan Python 3.10

Untuk menginstal semua paket Python yang diperlukan, jalankan perintah berikut:

pip install -r requirements.txt

Kami menggunakan PIPREQSNB untuk menghasilkan file persyaratan.txt. Untuk menginstal PIPREQSNB, jalankan perintah berikut:

pip install pipreqsnb

Untuk menghasilkan file persyaratan.txt, jalankan perintah berikut:

pipreqsnb --force .

Untuk menjalankan tes unit, Anda dapat menggunakan perintah berikut:

pytest -o " testpaths=tests " --noconftest