dataherald

Monorepo DataHerald

Permintaan data relasional Anda dalam bahasa alami .

| | Docs | Beranda

DataHerald adalah mesin bahasa alami-ke-SQL yang dibangun untuk pertanyaan tingkat perusahaan yang menjawab data relasional. Ini memungkinkan Anda untuk mengatur API dari database Anda yang dapat menjawab pertanyaan dalam bahasa Inggris biasa. Anda dapat menggunakan DataHerald untuk:

• Izinkan pengguna bisnis untuk mendapatkan wawasan dari gudang data tanpa melalui analis data
• Aktifkan Q+A dari DBS Produksi Anda Di Dalam Aplikasi SaaS Anda
• Buat plug-in chatgpt dari data hak milik Anda

Repositori ini berisi empat komponen di bawah /services yang dapat digunakan bersama untuk mengatur penyebaran data end-to-end:

1. Mesin: Mesin Bahasa Natural-ke-SQL inti. Jika Anda ingin menggunakan API DataHerald tanpa pengguna atau otentikasi, menjalankan mesin sudah cukup.
2. Perusahaan: Lapisan API Aplikasi yang menambahkan otentikasi, organisasi dan pengguna, dan logika bisnis lainnya ke DataHerald.
3. Admin-Console: Komponen front-end DataHerald yang memungkinkan GUI untuk konfigurasi dan kemampuan observasi. Anda perlu menjalankan mesin dan perusahaan agar konsol admin berfungsi.
4. SlackBot: Slackbot yang memungkinkan pengguna dari saluran Slack untuk berinteraksi dengan DataHerald. Membutuhkan engine dan perusahaan untuk dijalankan.

Untuk informasi lebih lanjut tentang setiap komponen, silakan lihat file README.md mereka.

Berjalan secara lokal

Setiap komponen dalam direktori /services memiliki file docker-compose.yml sendiri. Untuk mengatur lingkungan, ikuti langkah -langkah ini:

1. Atur Variabel Lingkungan : Setiap layanan membutuhkan variabel lingkungan tertentu. Lihat file .env.example di setiap direktori layanan dan buat file .env dengan nilai yang diperlukan.

   Untuk aplikasi front-end berikutnya adalah .env.local

2. Jalankan Layanan : Anda dapat menjalankan semua layanan menggunakan skrip tunggal yang terletak di direktori root. Skrip ini membuat jaringan Docker umum dan menjalankan setiap layanan dalam mode terpisah.

Jalankan skrip untuk memulai semua layanan:

sh docker-run.sh

Berkontribusi

Sebagai proyek open-source di bidang yang berkembang pesat, kami terbuka untuk kontribusi, apakah itu dalam bentuk fitur baru, peningkatan infrastruktur, atau dokumentasi yang lebih baik.

Untuk informasi terperinci tentang cara berkontribusi, lihat di sini.