dataherald

DataHerald Monorepo

リレーショナルデータを自然言語で照会します。

| |ドキュメント|ホームページ

DataHeraldは、リレーショナルデータに応答するエンタープライズレベルの質問用に構築された自然言語からSQLへのエンジンです。これにより、データベースからAPIを設定することができます。これは、平易な英語で質問に答えることができます。 DataHeraldを使用して以下を使用できます。

• ビジネスユーザーがデータアナリストを通過せずにデータウェアハウスから洞察を得ることができます
• SaaSアプリケーション内の生産DBSからQ+Aを有効にする
• 独自のデータからChatGPTプラグインを作成します

このリポジトリには、エンドツーエンドのデータヘルド展開をセットアップするために一緒に使用できる4つのコンポーネント/servicesが含まれています。

1. エンジン：Core Natural Language-to-SQLエンジン。ユーザーや認証なしでDataherald APIを使用したい場合は、エンジンを実行するだけで十分です。
2. エンタープライズ：認証、組織、ユーザー、およびその他のビジネスロジックをDataHeraldに追加するアプリケーションAPIレイヤー。
3. Admin-Console：構成と観察性のためのGUIを可能にするDataHeraldのフロントエンドコンポーネント。管理者が機能するには、エンジンとエンタープライズの両方を実行する必要があります。
4. SlackBot：SlackチャンネルのユーザーがDataHeraldと対話できるようにするSlackBot。実行するには、エンジンとエンタープライズの両方が必要です。

各コンポーネントの詳細については、 README.mdファイルをご覧ください。

ローカルで実行されます

/servicesディレクトリの各コンポーネントには、独自のdocker-compose.ymlファイルがあります。環境をセットアップするには、次の手順に従ってください。

1. 環境変数の設定：各サービスには特定の環境変数が必要です。各サービスディレクトリの.env.exampleファイルを参照し、必要な値を持つ.envファイルを作成します。

   next.jsのフロントエンドアプリは.env.localです

2. サービスの実行：ルートディレクトリにある単一のスクリプトを使用して、すべてのサービスを実行できます。このスクリプトは、共通のDockerネットワークを作成し、各サービスを取り外しモードで実行します。

スクリプトを実行してすべてのサービスを開始します。

sh docker-run.sh

貢献

急速に発展している分野でのオープンソースプロジェクトとして、新しい機能、改善されたインフラストラクチャ、またはより良いドキュメントの形であろうと、貢献を受け入れています。

貢献方法の詳細については、こちらをご覧ください。