dataherald

Dataherald monorepo

Interrogez vos données relationnelles en langage naturel .

| | Docs | Page d'accueil

Dataherald est un moteur de langage naturel à SQL conçu pour les questions au niveau de l'entreprise répondant aux données relationnelles. Il vous permet de configurer une API de votre base de données qui peut répondre aux questions en anglais simple. Vous pouvez utiliser DataHerald pour:

• Permettez aux utilisateurs professionnels d'obtenir des informations de l'entrepôt de données sans passer par un analyste de données
• Activez Q + A de votre DBS de production à l'intérieur de votre application SaaS
• Créez un plug-in chatppt à partir de vos données propriétaires

Ce référentiel contient quatre composants sous /services qui peuvent être utilisés ensemble pour configurer un déploiement de Dataherald de bout en bout:

1. Moteur: le moteur de la langue naturelle à SQL de base. Si vous souhaitez utiliser l'API DataHerald sans utilisateurs ni authentification, l'exécution du moteur suffira.
2. Enterprise: la couche d'API d'application qui ajoute l'authentification, les organisations et les utilisateurs et d'autres logiques métier à Dataherald.
3. Admin-Console: le composant frontal de DataHerald qui permet une interface graphique pour la configuration et l'observabilité. Vous devrez exécuter le moteur et l'entreprise pour que l'administrateur-console fonctionne.
4. SlackBot: un Slackbot qui permet aux utilisateurs d'un canal Slack d'interagir avec Dataherald. Nécessite à la fois le moteur et l'entreprise pour s'exécuter.

Pour plus d'informations sur chaque composant, veuillez consulter leurs fichiers README.md .

Courir localement

Chaque composant du répertoire /services a son propre fichier docker-compose.yml . Pour configurer l'environnement, suivez ces étapes:

1. Définir les variables d'environnement : chaque service nécessite des variables d'environnement spécifiques. Reportez-vous au fichier .env.example dans chaque répertoire de service et créez un fichier .env avec les valeurs nécessaires.

   Pour l'application frontale suivante .env.local

2. Exécuter des services : vous pouvez exécuter tous les services à l'aide d'un seul script situé dans le répertoire racine. Ce script crée un réseau Docker commun et exécute chaque service en mode détaché.

Exécutez le script pour démarrer tous les services:

sh docker-run.sh

Contributif

En tant que projet open source dans un domaine en développement rapide, nous sommes ouverts aux contributions, que ce soit sous la forme d'une nouvelle fonctionnalité, d'une infrastructure améliorée ou d'une meilleure documentation.

Pour des informations détaillées sur la façon de contribuer, voir ici.