dataherald

DataHerald Monorepo

Fragen Sie Ihre relationalen Daten in der natürlichen Sprache ab .

| | Docs | Homepage

DataHerald ist eine natürliche Sprache zu SQL-Engine, die für Fragen auf Unternehmensebene erstellt wurde, die über relationale Daten beantwortet wird. Sie können eine API aus Ihrer Datenbank einrichten, die Fragen in einfachem Englisch beantworten kann. Sie können DataHerald verwenden, um:

• Ermöglichen Sie Geschäftsnutzern, Erkenntnisse aus dem Data Warehouse zu erhalten, ohne einen Datenanalyst durchzugehen
• Aktivieren Sie Q+A aus Ihrer Produktion DBS in Ihrer SaaS -Anwendung
• Erstellen Sie ein ChatGPT-Plug-In aus Ihren proprietären Daten

Dieses Repository enthält vier Komponenten unter /services , die zusammen verwendet werden können, um eine End-to-End-Datenherd-Bereitstellung einzurichten:

1. Engine: Die natürliche Kern-Sprache zu SQL-Motor. Wenn Sie die DataHerald -API ohne Benutzer oder Authentifizierung verwenden möchten, reicht das Ausführen der Engine aus.
2. Enterprise: Die Anwendungs ​​-API -Ebene, die DataHerald Authentifizierung, Organisationen und Benutzer sowie andere Geschäftslogik hinzufügt.
3. Admin-Konsole: Die Front-End-Komponente von DataHerald, die eine GUI für die Konfiguration und Beobachtbarkeit ermöglicht. Sie müssen sowohl Motor als auch Unternehmen ausführen, damit die Administratorkonsole funktioniert.
4. Slackbot: Ein Slackbot, mit dem Benutzer aus einem Slack -Kanal mit DataHerald interagieren können. Erfordert sowohl Motor als auch Unternehmen.

Weitere Informationen zu jeder Komponente finden Sie in ihren README.md -Dateien.

Vor Ort laufen

Jede Komponente im Verzeichnis /services hat eine eigene docker-compose.yml Datei. Befolgen Sie die folgenden Schritte, um die Umgebung einzurichten:

1. Setzen Sie Umgebungsvariablen : Jeder Dienst benötigt spezifische Umgebungsvariablen. Siehe .env.example -Datei in jedem Dienstverzeichnis und erstellen Sie eine .env -Datei mit den erforderlichen Werten.

   Für die nächste .env.local

2. Ausführungsdienste : Sie können alle Dienste über ein einzelnes Skript im Root -Verzeichnis ausführen. Dieses Skript erstellt ein gemeinsames Docker -Netzwerk und führt jeden Dienst im abgetrennten Modus aus.

Führen Sie das Skript aus, um alle Dienste zu starten:

sh docker-run.sh

Beitragen

Als Open-Source-Projekt in einem sich schnell entwickelnden Bereich sind wir offen für Beiträge, sei es in Form eines neuen Merkmals, einer verbesserten Infrastruktur oder einer besseren Dokumentation.

Detaillierte Informationen zum Beitrag zum Beitrag finden Sie hier.