Delphic
v1.0.0 - PoC Release
Saya tidak punya waktu untuk mempertahankannya dan perlu sejumlah peningkatan untuk siap diproduksi. Beri tahu saya jika Anda tertarik untuk mengambil alih pemeliharaan.
Kerangka kerja sederhana untuk menggunakan llamaindex untuk membangun dan menggunakan agen LLM yang dapat digunakan untuk menganalisis dan memanipulasi data teks dari dokumen.
Lisensi: MIT
Rilis awal Delphic hanya didasarkan pada API Openai. Kami sepenuhnya berencana untuk mendukung model bahasa besar lainnya (LLM), baik yang di-host sendiri atau didukung oleh API pihak ketiga. Namun, pada saat ini, pada April 2023, API AI yang terbuka mungkin tetap yang paling mampu dan termudah untuk digunakan. Karena kerangka kerja ini didasarkan pada llamaindex dan sepenuhnya kompatibel dengan langchain, akan sangat mudah untuk menggunakan LLM lainnya. Namun, saat ini, teks Anda akan diproses dengan OpenAi, bahkan jika Anda melakukan tuan rumah sendiri alat ini. Jika ketentuan layanan OpenAI menghadirkan masalah bagi Anda, kami menyerahkannya kepada Anda untuk menyelesaikannya. Kami tidak bertanggung jawab atas masalah apa pun yang terjadi dari penggunaan alat ini dan API OpenAI.
Cara tercepat untuk bangun dan berjalan adalah dengan mengkloning repo ini dan kemudian menggunakan aplikasi secara lokal.
Anda akan membutuhkan Docker dan Docker untuk mengikuti instruksi ini. Digitalocean, selain menjadi tuan rumah cloud yang sangat baik, memiliki beberapa instruksi yang paling mudah diikuti untuk mengaturnya. Silakan periksa di sini atau buka instruksi resmi Docker.
git clone
cd delphic
mkdir -p ./.envs/.local/
cp -a ./docs/sample_envs/local/.frontend ./frontend
cp -a ./docs/sample_envs/local/.django ./.envs/.local
cp -a ./docs/sample_envs/local/.postgres ./.envs/.local
Dan, selanjutnya perbarui konfigurasi .django Anda (Anda mungkin ingin mengedit .postgres juga untuk memberikan kata sandi unik kepada pengguna database Anda) untuk memasukkan kunci API openai Anda
Kemudian, bangun gambar Docker:
sudo docker-compose --profile fullstack -f local.yml build
sudo docker-compose --profile fullstack -f local.yml up
Pergi ke localhost:3000 untuk melihat frontend.
Jika Anda ingin secara aktif mengembangkan frontend, kami sarankan Anda tidak menggunakan bendera --profile=fullstack karena setiap perubahan akan memerlukan pembangunan kembali kontainer penuh. Sebaliknya, lihat lingkungan pengembangan alih -alih langkah #5 di atas,
Ini mengasumsikan Anda ingin membuat aplikasi tersedia di internet di semacam domain yang sepenuhnya memenuhi syarat seperti delphic.opensource.legal. Untuk melakukan ini, Anda perlu memperbarui beberapa konfigurasi.
TODO - Masukkan dokumentasi
Untuk benar -benar menggunakan aplikasi (saat ini, kami bermaksud memungkinkan untuk berbagi model tertentu dengan pengguna yang tidak aautentikasi), Anda memerlukan login. Anda dapat menggunakan superuser atau non-superuser. Dalam kedua kasus tersebut, seseorang harus terlebih dahulu membuat superuser menggunakan konsol:
Mengapa Menyiapkan Superuser Django? Superuser Django memiliki semua izin dalam aplikasi dan dapat mengelola semua aspek sistem, termasuk membuat, memodifikasi, dan menghapus pengguna, koleksi, dan data lainnya. Menyiapkan superuser memungkinkan Anda untuk sepenuhnya mengontrol dan mengelola aplikasi.
** Saat ini, setiap pengguna yang masuk akan memiliki izin penuh. Kami berencana untuk mengimplementasikan modul kontrol akses berbasis peran yang lebih tepat yang kami kembangkan untuk OpenContracts, tetapi, untuk sekarang menyadari bahwa siapa pun dengan semua jenis kredensial login dapat membuat dan menghapus koleksi. Membuat Koleksi Menggunakan Kredit Openai / Biaya Uang
sudo docker-compose -f local.yml run django python manage.py createsuperuser
Mulai aplikasi Delphic Anda secara lokal mengikuti instruksi penyebaran.
Peringatan - Jika Anda menggunakan OpenAi sebagai mesin LLM Anda, interaksi koleksi apa pun akan menggunakan kredit API / biaya biaya. Jika Anda menggunakan kunci API OpenAI Anda sendiri, Anda juga telah menerima ketentuan layanan mereka yang mungkin tidak cocok untuk kasus penggunaan Anda. Tolong lakukan ketekunan Anda sendiri.
Untuk mengakses antarmuka imbalan pertanyaan, angkat fullstack, dan pergi ke http://localhost:3000
Jika Anda ingin berkontribusi pada Delphic atau menggulung versi Anda sendiri, Anda ingin memastikan Anda mengatur lingkungan pengembangan.
Di backend, Anda harus memiliki lingkungan Python yang berfungsi untuk menjalankan pemeriksaan format pra-komit. Anda dapat menggunakan interpreter Python sistem Anda, tetapi kami sarankan menggunakan PyenV dan membuat env virtual berdasarkan Python> = 3.10.
Kemudian, dalam akar repo lokal Anda, jalankan perintah ini:
pip install -r ./requirements/local.txt
pre-commit install
Sekarang, ketika Anda melakukan komitmen, pemformatan kode dan pemeriksaan gaya akan berjalan secara otomatis.
Kami memiliki suite tes dasar di ./tests . Anda dapat menjalankan tes dengan mengetik:
sudo docker-compose -f local.yml run django python manage.py test
Di frontend, kami menggunakan Node V18.15.0. Kami menganggap Anda menggunakan NVM. Kami belum memiliki tes frontend (maaf).
CD ke direktori frontend, instal dependensi frontend Anda dan mulai server pengembangan ( Catatan, kami menganggap Anda telah menginstal NVM. Jika Anda tidak menginstalnya sekarang ):
cd frontend
nvm use
npm install yarn
yarn install
Mengetik yarn start Akan Membawa Server Pengembangan Frontend Anda di http://localhost:3000 . Anda masih perlu meluncurkan backend agar berfungsi dengan baik.
fullstackLuncurkan backend tanpa bendera fullstack:
sudo docker-compose -f local.yml up
