dataherald

DataHerald Monorepo

用自然語言查詢您的關係數據。

| |文檔|首頁

DataHerald是為企業級問題構建的自然語言到SQL引擎，對關係數據回答。它使您可以從數據庫中設置一個API，可以用簡單的英語回答問題。您可以使用DataHerald來：

• 允許企業用戶在無需數據分析師的情況下從數據倉庫中獲得見解
• 從您的SaaS應用程序中啟用生產DB的Q+A
• 從您的專有數據創建ChatGpt插件

該存儲庫包含四個組件/services ，可以一起使用這些組件來設置端到端DataHerArt部署：

1. 引擎：核心自然語言到SQL引擎。如果您想在沒有用戶或身份驗證的情況下使用DataHerald API，則運行引擎就足夠了。
2. 企業：將身份驗證，組織和用戶以及其他業務邏輯添加到DataHerald的應用程序API層。
3. Admin-Console：DataHerald的前端組件，允許GUI配置和可觀察性。您需要同時運行引擎和企業才能使管理員工作。
4. SlackBot：SlackBot，允許Slack Channel的用戶與DataHerald進行交互。需要發動機和企業運行。

有關每個組件的更多信息，請查看他們的README.md文件。

本地運行

/services目錄中的每個組件都有其自己的docker-compose.yml文件。要設置環境，請執行以下步驟：

1. 設置環境變量：每個服務都需要特定的環境變量。請參閱每個服務目錄中的.env.example文件，並創建具有必要值的.env文件。

   對於下一個。JS前端應用程序是.env.local

2. 運行服務：您可以使用位於根目錄中的單個腳本運行所有服務。該腳本創建一個通用的Docker網絡，並以獨立模式運行每個服務。

運行腳本以啟動所有服務：

sh docker-run.sh

貢獻

作為一個快速發展的領域的開源項目，我們願意貢獻，無論是以新功能的形式，改進的基礎架構還是更好的文檔。

有關如何貢獻的詳細信息，請參見此處。