https://github.com/Dataherald/dataherald Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} Dataherald / dataherald Public * Notifications * Fork 111 * Star 1.4k * Interact with your SQL database, Natural Language to SQL using LLMs dataherald.readthedocs.io/en/latest/ 1.4k stars 111 forks Branches Tags Activity Star Notifications * Code * Issues 3 * Pull requests 2 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights Dataherald/dataherald This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 924 Commits .github/workflows .github/ workflows services services .gitignore .gitignore README.md README.md docker-run.sh docker-run.sh View all files Repository files navigation * README Dataherald monorepo Dataherald logo Query your relational data in natural language. Discord | License | Docs | Homepage Dataherald is a natural language-to-SQL engine built for enterprise-level question answering over relational data. It allows you to set up an API from your database that can answer questions in plain English. You can use Dataherald to: * Allow business users to get insights from the data warehouse without going through a data analyst * Enable Q+A from your production DBs inside your SaaS application * Create a ChatGPT plug-in from your proprietary data This repository contains four components under /services which can be used together to set up an end-to-end Dataherald deployment: 1. Engine: The core natural language-to-SQL engine. If you would like to use the dataherald API without users or authentication, running the engine will suffice. 2. Enterprise: The application API layer which adds authentication, organizations and users, and other business logic to Dataherald. 3. Admin-console: The front-end component of Dataherald which allows a GUI for configuration and observability. You will need to run both engine and enterprise for the admin-console to work. 4. Slackbot: A slackbot which allows users from a slack channel to interact with dataherald. Requires both engine and enterprise to run. For more information on each component, please take a look at their README.md files. Running locally Each component in the /services directory has its own docker-compose.yml file. To set up the environment, follow these steps: 1. Set Environment Variables: Each service requires specific environment variables. Refer to the .env.example file in each service directory and create a .env file with the necessary values. For the Next.js front-end app is .env.local 2. Run Services: You can run all the services using a single script located in the root directory. This script creates a common Docker network and runs each service in detached mode. Run the script to start all services: sh docker-run.sh Contributing As an open-source project in a rapidly developing field, we are open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation. For detailed information on how to contribute, see here. About Interact with your SQL database, Natural Language to SQL using LLMs dataherald.readthedocs.io/en/latest/ Topics sql database ai finetuning text-to-sql rag llm nl-to-sql Resources Readme Activity Custom properties Stars 1.4k stars Watchers 16 watching Forks 111 forks Report repository Releases 9 v1.0.3 Latest Apr 30, 2024 + 8 releases Packages 0 No packages published Contributors 16 * * * * * * * * * * * * * * + 2 contributors Languages * Python 58.4% * TypeScript 39.4% * JavaScript 1.3% * Dockerfile 0.3% * Shell 0.2% * CSS 0.2% * Other 0.2% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.