dataherald

Dataherald Monorepo

Consulte sus datos relacionales en lenguaje natural .

| | Docios | Página principal

Dataherald es un motor natural de lenguaje a SQL creado para preguntas a nivel empresarial que responde sobre datos relacionales. Le permite configurar una API de su base de datos que pueda responder preguntas en inglés simple. Puede usar Dataherald para:

• Permitir a los usuarios comerciales obtener información del almacén de datos sin pasar por un analista de datos
• Habilite Q+A de su DBS de producción dentro de su aplicación SaaS
• Cree un complemento ChatGPT a partir de sus datos patentados

Este repositorio contiene cuatro componentes bajo /services que se pueden usar juntos para configurar una implementación de Dataherald de extremo a extremo:

1. Motor: el motor central de lenguaje natural a SQL. Si desea utilizar la API Dataherald sin usuarios o autenticación, ejecutar el motor será suficiente.
2. Enterprise: la capa API de la aplicación que agrega autenticación, organizaciones y usuarios, y otra lógica comercial a Dataherald.
3. Consejo de administración: el componente front-end de Dataherald que permite una GUI para la configuración y la observabilidad. Deberá ejecutar tanto el motor como la empresa para que funcione la consola administradora.
4. Slackbot: un Slackbot que permite a los usuarios de un canal Slack interactuar con Dataherald. Requiere que tanto el motor como la empresa funcionen.

Para obtener más información sobre cada componente, eche un vistazo a sus archivos README.md .

Ejecutando localmente

Cada componente en el directorio /services tiene su propio archivo docker-compose.yml . Para configurar el entorno, siga estos pasos:

1. Establecer variables de entorno : cada servicio requiere variables de entorno específicas. Consulte el archivo .env.example en cada directorio de servicio y cree un archivo .env con los valores necesarios.

   Para la aplicación front-end de Next.js es .env.local

2. Servicios de ejecución : puede ejecutar todos los servicios utilizando un solo script ubicado en el directorio raíz. Este script crea una red Docker común y ejecuta cada servicio en modo separado.

Ejecute el script para iniciar todos los servicios:

sh docker-run.sh

Que contribuye

Como un proyecto de código abierto en un campo de rápido desarrollo, estamos abiertos a contribuciones, ya sea en forma de una nueva característica, infraestructura mejorada o mejor documentación.

Para obtener información detallada sobre cómo contribuir, consulte aquí.