BanterBot

Banterbot

Banterbot adalah aplikasi chatbot yang ramah pengguna yang memanfaatkan model OpenAI untuk menghasilkan respons sadar konteks, suara saraf Azure untuk sintesis teks-ke-ucapan, dan pengakuan ucapan-ke-teks. Paket ini menawarkan toolkit yang komprehensif untuk membangun aplikasi chatbot dengan antarmuka intuitif dan serangkaian utilitas.

Fitur

• Memanfaatkan model openai untuk menghasilkan tanggapan yang sadar konteks
• Memanfaatkan suara saraf biru untuk sintesis teks-ke-speech premium
• Menawarkan berbagai format output, suara multibahasa, dan gaya berbicara
• Memungkinkan pemantauan real-time dari tanggapan chatbot
• Mendukung input mikrofon ucapan-ke-teks asinkron
• Termasuk kelas dasar abstrak untuk membuat frontend kustom untuk aplikasi Banterbot
• Fitur implementasi frontend berbasis tkinter
• Secara otomatis memilih emosi atau nada yang sesuai berdasarkan konteks percakapan

Persyaratan

Tiga variabel lingkungan diperlukan untuk fungsionalitas penuh:

• OPENAI_API_KEY : Kunci API OpenAI yang valid
• AZURE_SPEECH_KEY : Kunci API Pidato Layanan Kognitif Azure yang valid untuk fungsi teks-ke-speech dan ucapan-ke-teks
• AZURE_SPEECH_REGION : wilayah yang terkait dengan kunci API Layanan Kognitif Azure Anda

Komponen

Tkinterface

Antarmuka pengguna grafis (GUI) menetapkan lingkungan percakapan multipemain di mana hingga sembilan pengguna dapat berinteraksi dengan chatbot secara bersamaan. GUI mencakup area riwayat percakapan dan panel pengguna dengan tombol 'Dengarkan' untuk memproses input pengguna. Ini juga mendukung binding kunci untuk kenyamanan pengguna.

OpenAiservice

Kelas yang bertanggung jawab untuk mengelola interaksi dengan OpenAI Chatcompletion API. Ini menawarkan fungsionalitas untuk menghasilkan respons dari API berdasarkan pesan input. Ini mendukung menghasilkan respons secara keseluruhan atau sebagai aliran blok respons.

PidatoSynthesisservice

Kelas yang menangani sintesis teks-ke-unggun menggunakan layanan kognitif Azure. Ini mendukung berbagai format output, suara, dan gaya berbicara. Pidato yang disintesis dapat terganggu, dan kemajuan dapat dipantau secara real-time.

Pidato -cognitionservice

Kelas yang menyediakan antarmuka untuk mengubah bahasa lisan menjadi teks tertulis menggunakan layanan kognitif Azure. Ini memungkinkan pengenalan ucapan terus menerus dan memberikan hasil waktu nyata karena kalimat diakui.

Instalasi

Catatan penting

Banterbot memerlukan beberapa model bahasa spacy untuk dijalankan, dan secara otomatis akan mengunduhnya pada inisialisasi pertama kali, jika mereka hilang atau tidak kompatibel-proses ini kadang-kadang bisa memakan waktu cukup lama.

Pip (direkomendasikan)

Banterbot dapat diinstal atau diperbarui menggunakan Indeks Paket Python (PYPI):

python -m pip install --upgrade banterbot

Manual

Untuk menginstal Banderbot, cukup klon repositori dan menginstal dependensi yang diperlukan:

git clone https://github.com/gabrielscabrera/banterbot.git
cd banterbot
python -m pip install . 

Penggunaan

Luncurkan dengan baris perintah

Mulai banterbot dengan antarmuka pengguna grafis yang disempurnakan dengan menjalankan perintah banterbot di terminal Anda. GUI ini memungkinkan banyak pengguna untuk berinteraksi dengan bot, masing -masing dengan tombol khusus untuk input ucapan dan tampilan untuk tanggapan.

--prompt : Tetapkan prompt sistem di awal percakapan (misalnya, --prompt "You are Grendel the Quiz Troll, a charismatic troll who loves to host quiz shows." ).

--model : Pilih model OpenAI untuk pembuatan percakapan. Default ke GPT-4, tetapi versi lain dapat dipilih jika ditentukan dalam kode.

--voice : Pilih suara Microsoft Azure Cognitive Services Text-to-Speech. Standarnya adalah "ARIA," tetapi suara -suara lain dapat ditentukan jika tersedia.

--debug : Aktifkan mode debug untuk menampilkan informasi tambahan di terminal untuk pemecahan masalah.

--greet : Mintalah bot menyapa pengguna saat startup.

--name : Tetapkan nama kepada Asisten untuk tujuan estetika. Ini tidak menginformasikan bot itu sendiri; Untuk memberikan informasi kepada bot, gunakan bendera --prompt .

Inilah contohnya:

banterbot --greet --model gpt-4-turbo --voice davis --prompt " You are Grondle the Quiz Troll, a charismatic troll who loves to host quiz shows. " --name Grondle

Selain itu, Anda dapat menggunakan banterbot character untuk memilih karakter yang telah dimuat sebelumnya untuk berinteraksi. Misalnya:

banterbot character therapist

Akan memulai percakapan dengan Grendel the Therapy Troll. Untuk mendaftar semua karakter yang tersedia, jalankan:

banterbot character -h

Anda juga dapat menggunakan banterbot voice-search untuk mencari melalui semua suara yang tersedia. Misalnya:

banterbot voice-search --language en fr

Akan mencantumkan semua model suara bahasa Inggris (en) dan Prancis (FR). Jalankan banterbot voice-search -h untuk informasi lebih lanjut.

Luncurkan dengan skrip Python

Untuk menggunakan banterbot dalam skrip, buat instance dari kelas TKInterface dan hubungi metode run :

 from banterbot import AzureNeuralVoiceManager , OpenAIModelManager , TKInterface

model = OpenAIModelManager . load ( "gpt-4o" )
voice = AzureNeuralVoiceManager . load ( "Davis" )
assistant_name = "Grendel"

# Optional system prompt to set up a custom character prior to initializing BanterBot.
system = "You are Grendel the Quiz Troll, a charismatic troll who loves to host quiz shows."

# The four arguments `model`, `voice`, `system`, and `assistant_name` are optional.
interface = TKInterface ( model = model , voice = voice , system = system , assistant_name = assistant_name )

# Setting `greet` to True instructs BanterBot to initiate the conversation. Otherwise, the user must initiate.
interface . run ( greet = True )

Log obrolan

Log obrolan disimpan dalam $HOME/Documents/BanterBot/Conversations/ direktori sebagai file .txt individual.

Dokumentasi

Untuk dokumentasi yang lebih lengkap, silakan merujuk ke dokumen banterbot.