dataherald

DataHerald Monorepo

Consulte seus dados relacionais em linguagem natural .

| | DOCs | Página inicial

O DataHerald é um mecanismo natural de idioma para SQL, construído para perguntas em nível corporativo, respondendo a dados relacionais. Ele permite que você configure uma API do seu banco de dados que pode responder a perguntas em inglês simples. Você pode usar o DataHerald para:

• Permita que os usuários de negócios obtenham informações do data warehouse sem passar por um analista de dados
• Ativar Q+A do seu DBS de produção dentro do seu aplicativo SaaS
• Crie um plug-in chatgpt a partir de seus dados proprietários

Este repositório contém quatro componentes sob /services que podem ser usados ​​juntos para configurar uma implantação de ponta a ponta DataHerald:

1. Motor: o principal mecanismo de idioma natural para SQL. Se você deseja usar a API DataHerald sem usuários ou autenticação, a execução do mecanismo será suficiente.
2. Enterprise: a camada de API do Application que adiciona autenticação, organizações e usuários e outra lógica de negócios a DataHerald.
3. Admin-Console: o componente front-end do DataHerald, que permite uma GUI para configuração e observabilidade. Você precisará executar o motor e o empreendimento para que o console do administrador funcione.
4. Slackbot: um slackbot que permite que os usuários de um canal Slack interajam com o DataHerald. Requer que o motor e o empreendimento sejam executados.

Para obter mais informações sobre cada componente, consulte seus arquivos README.md .

Executando localmente

Cada componente no diretório /services possui seu próprio arquivo docker-compose.yml . Para configurar o ambiente, siga estas etapas:

1. Definir variáveis ​​de ambiente : cada serviço requer variáveis ​​de ambiente específicas. Consulte o arquivo .env.example em cada diretório de serviço e crie um arquivo .env com os valores necessários.

   Para o próximo.js, o aplicativo front-end é .env.local

2. Serviços de execução : você pode executar todos os serviços usando um único script localizado no diretório raiz. Este script cria uma rede de docker comum e executa cada serviço no modo destacado.

Execute o script para iniciar todos os serviços:

sh docker-run.sh

Contribuindo

Como um projeto de código aberto em um campo em rápido desenvolvimento, estamos abertos a contribuições, seja na forma de um novo recurso, infraestrutura aprimorada ou melhor documentação.

Para obter informações detalhadas sobre como contribuir, consulte aqui.