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

贡献

作为一个快速发展的领域的开源项目，我们愿意贡献，无论是以新功能的形式，改进的基础架构还是更好的文档。

有关如何贡献的详细信息，请参见此处。