younited genaibots

Proyek GenaiBots

Ringkasan

GenaiBots adalah kerangka kerja komprehensif yang dirancang untuk mengotomatisasi dan mengelola interaksi di berbagai platform digital. Ini pada dasarnya adalah alat perusahaan untuk mengintegrasikan AI generatif ke dalam proses operasional melalui media seperti pesan instan, email, alat tiket, atau alat internal. Memanfaatkan AI canggih dan sistem plugin modular, hal ini memungkinkan terciptanya alur operasional canggih dan model interaksi yang disesuaikan untuk bisnis dan pengembang.

Detail selengkapnya di wiki https://github.com/YounitedCredit/younited-genaibots/wiki Anda juga dapat menggunakan obrolan dengan GPT khusus di sini untuk pertanyaan apa pun terkait pemasangan, konfigurasi, dan pengembangan GenaiBots: https://chatgpt. com/g/g-HGEDT9hA2-genaibots-asisten

contoh klien web ini berfungsi baik dengan kerangka kerja jika Anda ingin mengujinya dengan cepat: https://github.com/Pilosite/genaibot-basicweb-client

Fitur Utama

• Peningkatan AI : Mengintegrasikan AI generatif sebagai inti interaksi. Hal ini memungkinkan tidak hanya pembuatan AI khusus melalui perintah, tetapi juga kemampuan untuk memicu tindakan dan mengelola proses dengan putaran umpan balik yang cepat.
• Penangan Tindakan Kustom : Membuat tindakan kustom dengan mudah berdasarkan pemicu dan kondisi tertentu, dan menjalankannya secara langsung melalui perintah.
• Arsitektur Plugin yang Dapat Diperluas : Perluas fungsionalitas atau integrasikan layanan pihak ketiga melalui plugin, memastikan fleksibilitas dan ekstensibilitas.
• Integrasi dengan Sistem Perusahaan : Antarmuka AI generatif secara mulus dalam infrastruktur TI inti melalui server web atau container Docker. Hal ini memungkinkan pemrosesan dan pelacakan tugas yang dilakukan oleh bot di berbagai konteks (perpesanan, alat tiket, email, aplikasi khusus).
• Layanan Backend Dinamis : Terintegrasi dengan berbagai layanan backend untuk pemrosesan dan penyimpanan data, memungkinkan sistem beradaptasi dengan kasus penggunaan dan persyaratan perusahaan tertentu.

Persyaratan Sistem

• Sistem Operasi : Kompatibel dengan Windows, MacOS, dan Linux.
• Versi Python : 3.8 atau lebih baru.
• Perpustakaan dan Ketergantungan Tambahan : Tercantum dalam file requirements.txt .

Panduan Instalasi

1. Kloning Repositori

   git clone https://github.com/YounitedCredit/younited-genaibots
   cd genaibots

2. Atur Lingkungan Virtual (Disarankan)

   python -m venv venv
   source venv/bin/activate  # On Windows use `venvScriptsactivate`

3. Instal Dependensi

   pip install -r requirements.txt

Konfigurasi

Konfigurasikan pengaturan aplikasi dengan mengedit file config.yaml di direktori config . Pastikan semua kunci API dan konfigurasi database yang diperlukan telah diatur dengan benar.

config.yaml

File config.yaml memusatkan pengaturan konfigurasi untuk aplikasi GenaiBots. Berikut beberapa bagian penting dan tujuannya:

• BOT_CONFIG : Berisi pengaturan yang terkait dengan perilaku bot dan tingkat debugging.

  • LOG_DEBUG_LEVEL : Mendefinisikan tingkat debug untuk logging.
  • PROMPTS_FOLDER , CORE_PROMPT , MAIN_PROMPT , SUBPROMPTS_FOLDER : Tentukan direktori dan file untuk petunjuknya.
  • SHOW_COST_IN_THREAD : Beralih untuk menampilkan informasi biaya di thread.
  • Berbagai nama dan perilaku default plugin juga dikonfigurasi di sini.

• UTILS : Berisi konfigurasi utilitas, seperti pengaturan logging.

  • LOGGING : Mengonfigurasi pembuatan log, termasuk jalur sistem file dan pengaturan Azure.

• PLUGIN : Mendefinisikan plugin yang tersedia dan konfigurasinya.

  • Kategori mencakup ACTION_INTERACTIONS , BACKEND , USER_INTERACTIONS , GENAI_INTERACTIONS , dan USER_INTERACTIONS_BEHAVIORS .

Pengaturan Lingkungan

Variabel lingkungan dimuat melalui python-dotenv , biasanya dari file .env . Hal ini memungkinkan aplikasi memuat data sensitif seperti kunci API dan URL database dengan aman. Berikut ikhtisar dasar tentang cara kerja pengaturan lingkungan di GenaiBots:

1. Memuat Variabel Lingkungan : fungsi load_dotenv() dipanggil untuk memuat variabel lingkungan dari file .env ke dalam aplikasi.
2. Mengakses Variabel Lingkungan : Pengaturan konfigurasi di config.yaml dapat mereferensikan variabel lingkungan ini menggunakan sintaks $(ENV_VAR_NAME) .

Menjalankan Aplikasi

Jalankan perintah berikut di direktori root proyek:

python app.py

Ini akan memulai server dan mulai menangani permintaan berdasarkan tindakan dan pemicu yang dikonfigurasi.

Men-debug dalam Kode Visual Studio

Untuk men-debug aplikasi dalam Visual Studio Code, gunakan perintah berikut:

c: ; cd ' c:reposYuc.GenaiBots ' ; & ' C:Users<your profile>miniconda3python.exe ' ' c:Users<your profile>.vscodeextensionsms-python.debugpy-2024.6.0-win32-x64bundledlibsdebugpyadapter/../..debugpylauncher ' ' 64580 ' ' -- ' ' -m ' ' uvicorn ' ' app:app ' ' --host ' ' localhost ' ' --port ' ' 7071 ' ' --workers ' ' 1 ' 

Arsitektur Plugin

GenaiBots menggunakan arsitektur plugin modular yang dikategorikan ke dalam beberapa keluarga:

1. Interaksi Aksi :

   • Plugin Default : Tindakan yang telah ditentukan sebelumnya untuk tugas umum.
   • Plugin Khusus : Tindakan yang ditentukan pengguna yang disesuaikan dengan kebutuhan spesifik.

2. Bagian belakang :

   • Menangani pemrosesan data internal dan interaksi dengan layanan backend.

3. Interaksi Pengguna :

   • Pesan Instan : Plugin untuk menangani platform perpesanan seperti Slack dan Teams.
   • API Khusus : Plugin untuk berinteraksi dengan API khusus.

4. Interaksi GenAI :

   • Teks : Plugin untuk menghasilkan dan menangani interaksi teks menggunakan AI.
   • Gambar : Plugin untuk menghasilkan dan menangani interaksi gambar menggunakan AI.
   • Pencarian Vektor : Plugin untuk menangani fungsi pencarian vektor.

5. Perilaku Interaksi Pengguna :

   • Mendefinisikan perilaku interaksi pengguna di berbagai platform perpesanan dan API khusus.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT - lihat file LICENSE.md untuk lebih jelasnya.

Dukungan dan Kontak

Untuk pertanyaan dukungan apa pun atau untuk melaporkan masalah, silakan kunjungi halaman Masalah GitHub kami di: https://github.com/YounitedCredit/younited-genaibots/issues