Ragtime
Bot Rag Open-Source untuk Slack dan Perselisihan menggunakan Vectara. Dengan bot ini Anda dapat membuat bot Slack atau Discord yang terhubung ke server Anda dan menjawab pertanyaan pengguna dengan menanyakan corpus Vectara.
Penggunaan
- Sebutkan bot dalam pesan untuk menerima balasan.
- Kirim pesan langsung ke bot untuk percakapan 1: 1.
- Bot menyimpan pesan dan id utas untuk memberikan balasan sadar konteks di utas atau saat membalas.
Contoh Perintah
- Sebutkan bot:
@bot-name Your message here - Kirim pesan langsung:
Your message here
Instalasi
Prasyarat
- Python 3.8 atau lebih tinggi
Pengaturan
- Klon Repositori:
git clone https://github.com/vectara/ragtime.git
cd ragtime
- Instal dependensi yang diperlukan:
pip3 install requirement.txt
- Mengatur variabel lingkungan:
- Buat file
.env di root proyek Anda dan tambahkan yang berikut:
SLACK_BOT_TOKEN=<OAuth level token>
SLACK_APP_TOKEN=<APP level token>
DISCORD_BOT_TOKEN=<Discord bot token>
VECTARA_CUSTOMER_ID="<VECTARA_CUSTOMER_ID>"
VECTARA_CORPUS_IDS="<VECTARA_CORPUS_IDS>"
VECTARA_API_KEY="<VECTARA_API_KEY>"
ACCOUNT_SID=<Twilio account SID>
Auth_TOKEN=<Twilio auth token>
TWILIO_WHATSAPP_NUMBER=<Whatsapp number configured in twilio>
Untuk mengaktifkan kain agen, tambahkan variabel -variabel berikut.
ENABLE_AGENTIC_RAG=True ## To enable agentic rag. By default ragtime uses vanilla RAG.
AGENTIC_RAG_DATA_DESCRIPTION='Vectara website, docs and forum data'
AGENTIC_RAG_ASSISTANT_SPECIALTY='Vectara'
AGENTIC_RAG_TOOL_NAME='ask_vectara'
VECTARA_CUSTOMER_ID dan VECTARA_CORPUS_IDS menunjuk ke akun Vectara Anda dan korpora yang relevan untuk digunakan.-
VECTARA_CORPUS_IDS dapat berupa id corpus tunggal (numerik) atau daftar korpora yang dipisahkan koma.
Menjalankan bot ragtime
Ragtime mendukung Slack Bot, Discord Bot dan WhatsApp Bot. Anda dapat menjalankan salah satunya, atau semuanya.
Cara menjalankannya secara lokal
Menjalankan kedua bot
Hanya menjalankan bot kendur
Hanya menjalankan Bot Perselisihan
Hanya menjalankan bot whatsapp
Jalankan aplikasi menggunakan Docker
Bangun dan jalankan dengan Docker.
Menjalankan kedua bot
Hanya menjalankan bot kendur
Hanya menjalankan Bot Perselisihan
bash run_docker.sh discord
Hanya menjalankan bot whatsapp
bash run_docker.sh whatsapp
Langkah -langkah untuk Membuat Bot Slack
Di Orer untuk menghubungkan bot ragtime Anda ke layanan Slack Anda, ikuti langkah -langkah ini:
- Masuk ke ruang kerja Slack Anda dan navigasikan ke situs web Slack API. Klik "Aplikasi Anda" dan kemudian "Buat Aplikasi Baru." Berikan nama untuk aplikasi Anda, pilih ruang kerja tempat Anda ingin menginstalnya, dan klik "Buat Aplikasi."
- Di pengaturan aplikasi, Anda dapat mengonfigurasi berbagai detail seperti nama aplikasi, ikon, dan deskripsi. Pastikan untuk mengisi informasi yang diperlukan secara akurat.
- Setelah Anda mengkonfigurasi aplikasi Anda, navigasikan ke bagian "Instal Aplikasi". Klik tombol "Instal Aplikasi ke Workspace" untuk menambahkan bot ke ruang kerja Slack Anda. Langkah ini akan menghasilkan token akses oauth yang perlu Anda gunakan untuk mengotentikasi bot Anda.
- Untuk menambahkan ruang lingkup token pengguna, navigasikan ke bagian "OAuth & Izin" di pengaturan aplikasi Anda. Di bawah bagian "OAuth Tokens untuk Ruang Kerja Anda", Anda harus menambahkan
app_mentions:read , channels:history , chat:write , chat:write.public , groups:history , im:history , mpim:history , mpim:read , mpim:write , users:read Lingkup. Buat token dan simpan sebagai SLACK_BOT_TOKEN di file .env Anda. - Buat token level aplikasi dengan
connection:write ruang lingkup. Simpan token ini sebagai SLACK_APP_TOKEN di file .env Anda. - Pastikan untuk menyimpan perubahan apa pun yang telah Anda buat ke pengaturan aplikasi Anda dan menginstal/menginstal ulang bot ke tempat kerja.
Langkah untuk Membuat Bot Perselisihan
Untuk menghubungkan bot ragtime Anda ke server Discord Anda, ikuti langkah -langkah ini:
- Arahkan ke halaman Aplikasi Portal Pengembang Discord dan buat aplikasi baru dengan mengklik tombol 'Aplikasi Baru' di sudut kanan atas.
- Buka halaman 'bot' dengan memilih opsi 'bot' dari kolom kiri.
- Salin token yang disediakan dan simpan sebagai
DISCORD_BOT_TOKEN . - Pilih 'OAuth2' dari kolom kiri dan pilih generator URL.
- Di bagian 'Bot Izin' di bagian bawah, pilih izin yang diperlukan.
- Pilih opsi 'bot' di kotak 'SCOPE', dan kotak 'Bot Izin' akan muncul di bawahnya.
- Pilih 'Baca Pesan', 'Kirim Pesan', dan opsi 'Kelola Pesan'.
- Salin URL yang dihasilkan dan tempel ke browser web Anda. Ini akan mengarahkan Anda ke halaman Discord untuk menambahkan bot ke server Anda.
Cara mengatur bot whatsapp menggunakan twilio
Untuk menghubungkan bot whatsapp ragtime Anda, ikuti langkah -langkah ini:
- Masuk ke Twilio Console Anda.
- Arahkan ke kotak pasir whatsapp.
- Konfigurasikan titik akhir
/whatsapp untuk komunikasi. - Salin Akun Sid, Auth Token, dan Nomor Sandbox WhatsApp ke
.env
Pengarang
? Vectara
- Situs web: https://vectara.com
- Twitter: @Vectara
- GitHub: @Vectara
- LinkedIn: @Vectara
- Perselisihan: @Vectara
? Berkontribusi
Kontribusi, masalah, dan permintaan fitur dipersilakan!
Jangan ragu untuk memeriksa halaman masalah. Anda juga dapat melihat panduan yang berkontribusi.
Tunjukkan dukungan Anda
Berikan ️ jika proyek ini membantu Anda!
Lisensi
Hak Cipta © 2024 Vectara.
Proyek ini berlisensi Apache 2.0.