自然语言转SQL引擎开源

用自然语言查询关系型数据。

Dataherald 是一个自然语言转 SQL 引擎，为企业级关系型数据问答而构建。它允许你从数据库建立一个 API，能用纯英文回答问题。你可以用 Dataherald 来：

允许业务用户不用经过数据分析师就能从数据仓库获得洞察

在你的 SaaS 应用中启用生产数据库的问答

从你的专有数据创建 ChatGPT 插件

这个仓库在 /services 下包含四个组件，可以一起使用来设置端到端的 Dataherald 部署：

Engine： 核心自然语言转 SQL 引擎。如果你想在没有用户或认证的情况下使用 dataherald API，运行引擎就足够了。

Enterprise： 应用 API 层，为 Dataherald 添加认证、组织、用户和其他业务逻辑。

Admin-console： Dataherald 的前端组件，允许用于配置和可观测性的 GUI。你需要同时运行 engine 和 enterprise 才能让 admin-console 工作。

Slackbot： 一个 slackbot，允许来自 Slack 频道的用户与 dataherald 交互。需要同时运行 engine 和 enterprise。

有关每个组件的更多信息，请查看它们的 README.md 文件。

/services 目录中的每个组件都有自己的 docker-compose.yml 文件。要设置环境，请按照以下步骤进行：

设置环境变量： 每个服务需要特定的环境变量。参考每个服务目录中的 .env.example 文件，并创建一个包含必要值的 .env 文件。对于 Next.js 前端应用是 .env.local

运行服务： 你可以使用位于根目录的单个脚本运行所有服务。该脚本创建一个公共 Docker 网络并以分离模式运行每个服务。

运行脚本启动所有服务：

sh docker-run.sh

作为一个在快速发展领域的开源项目，我们欢迎贡献，无论是以新功能、改进基础设施还是更好的文档的形式。

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