{"id":13564090,"url":"https://github.com/Dataherald/dataherald","last_synced_at":"2025-04-03T21:30:21.689Z","repository":{"id":188531153,"uuid":"656385153","full_name":"Dataherald/dataherald","owner":"Dataherald","description":"Interact with your SQL database, Natural Language to SQL using LLMs","archived":false,"fork":false,"pushed_at":"2024-07-24T17:37:41.000Z","size":4551,"stargazers_count":3345,"open_issues_count":15,"forks_count":235,"subscribers_count":25,"default_branch":"main","last_synced_at":"2024-10-29T15:38:19.598Z","etag":null,"topics":["ai","database","finetuning","llm","nl-to-sql","rag","sql","text-to-sql"],"latest_commit_sha":null,"homepage":"https://dataherald.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dataherald.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-20T21:06:11.000Z","updated_at":"2024-10-27T10:15:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"8fa26006-1923-43a3-b14e-191551d610a9","html_url":"https://github.com/Dataherald/dataherald","commit_stats":null,"previous_names":["dataherald/dataherald"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fdataherald","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fdataherald/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fdataherald/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dataherald%2Fdataherald/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dataherald","download_url":"https://codeload.github.com/Dataherald/dataherald/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246981170,"owners_count":20863827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","database","finetuning","llm","nl-to-sql","rag","sql","text-to-sql"],"created_at":"2024-08-01T13:01:26.479Z","updated_at":"2025-04-03T21:30:21.667Z","avatar_url":"https://github.com/Dataherald.png","language":"Python","readme":"# Dataherald monorepo\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://dataherald.com\"\u003e\u003cimg src=\"https://files.dataherald.com/logos/dataherald.png\" alt=\"Dataherald logo\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cb\u003eQuery your relational data in natural language\u003c/b\u003e. \u003cbr /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/A59Uxyy2k9\" target=\"_blank\"\u003e\n      \u003cimg src=\"https://img.shields.io/discord/1138593282184716441\" alt=\"Discord\"\u003e\n  \u003c/a\u003e |\n  \u003ca href=\"./LICENSE\" target=\"_blank\"\u003e\n      \u003cimg src=\"https://img.shields.io/static/v1?label=license\u0026message=Apache 2.0\u0026color=white\" alt=\"License\"\u003e\n  \u003c/a\u003e |\n  \u003ca href=\"https://dataherald.readthedocs.io/\" target=\"_blank\"\u003e\n      Docs\n  \u003c/a\u003e |\n  \u003ca href=\"https://www.dataherald.com/\" target=\"_blank\"\u003e\n      Homepage\n  \u003c/a\u003e\n\u003c/p\u003e\n\nDataherald 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:\n\n- Allow business users to get insights from the data warehouse without going through a data analyst\n- Enable Q+A from your production DBs inside your SaaS application\n- Create a ChatGPT plug-in from your proprietary data\n\nThis repository contains four components under `/services` which can be used together to set up an end-to-end Dataherald deployment:\n\n1. 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.\n2. Enterprise: The application API layer which adds authentication, organizations and users, and other business logic to Dataherald. \n3. 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.\n4. Slackbot: A slackbot which allows users from a slack channel to interact with dataherald. Requires both engine and enterprise to run.\n\nFor more information on each component, please take a look at their `README.md` files.\n\n## Running locally\n\nEach component in the `/services` directory has its own `docker-compose.yml` file. To set up the environment, follow these steps:\n\n1. **Set Environment Variables**:\n   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. \n   \u003e For the Next.js front-end app is `.env.local`\n2. **Run Services**:\n   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.\n\nRun the script to start all services:\n\n```bash\nsh docker-run.sh\n```\n\n## Contributing\nAs 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.\n\nFor detailed information on how to contribute, see [here](CONTRIBUTING.md).\n","funding_links":[],"categories":["Python","Sql Generation","A01_文本生成_文本对话","Tools \u0026 Frameworks","Repos"],"sub_categories":["大语言对话模型及数据","Text2SQL"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDataherald%2Fdataherald","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDataherald%2Fdataherald","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDataherald%2Fdataherald/lists"}