Dataherald 모노레포

Dataherald는 관계형 데이터에 대한 기업 수준의 질의응답을 위해 구축된 자연어-SQL 엔진입니다. 이 엔진을 사용하면 평이한 영어로 질문에 답할 수 있는 데이터베이스 API를 설정할 수 있습니다. Dataherald를 사용하여 다음 작업을 수행할 수 있습니다:

• 비즈니스 사용자가 데이터 분석가를 거치지 않고도 데이터 웨어하우스에서 인사이트를 얻도록 허용합니다.
• SaaS 애플리케이션 내에서 프로덕션 DB로부터 Q+A 기능을 활성화합니다.
• 자체 보유 데이터로 ChatGPT 플러그인을 생성합니다.

이 리포지토리에는 /services 아래에 네 가지 구성 요소가 포함되어 있으며, 이들을 함께 사용하여 엔드투엔드(end-to-end) Dataherald 배포를 설정할 수 있습니다:

1. Engine: 핵심 자연어-SQL 엔진입니다. 사용자나 인증 없이 dataherald API를 사용하고 싶다면, engine만 실행하는 것으로 충분합니다.
2. Enterprise: 인증, 조직(organization), 사용자 등 다른 비즈니스 로직을 Dataherald에 추가하는 애플리케이션 API 계층입니다.
3. Admin-console: 설정 및 관찰 가능성(observability)을 위한 GUI를 제공하는 Dataherald의 프런트엔드 구성 요소입니다. admin-console이 작동하려면 engine과 enterprise 모두 실행해야 합니다.
4. Slackbot: 슬랙 채널의 사용자가 dataherald와 상호 작용할 수 있도록 하는 봇입니다. engine과 enterprise가 모두 실행되어야 합니다.

각 구성 요소에 대한 자세한 정보는 해당 README.md 파일을 참고해 주십시오.

로컬 실행하기 (Running locally)

/services 디렉터리 내의 각 구성 요소에는 자체 docker-compose.yml 파일이 있습니다. 환경을 설정하려면 다음 단계를 따르십시오:

1. 환경 변수 설정 (Set Environment Variables):
   각 서비스는 특정 환경 변수를 필요로 합니다. 각 서비스 디렉터리에 있는 .env.example 파일을 참조하여 필요한 값으로 .env 파일을 생성하십시오.

   Next.js 프론트엔드 앱의 경우 .env.local을 사용합니다.

2. 서비스 실행 (Run Services):
   루트 디렉터리에 위치한 단일 스크립트를 사용하여 모든 서비스를 실행할 수 있습니다. 이 스크립트는 공통 Docker 네트워크를 생성하고 각 서비스를 분리된 모드(detached mode)로 실행합니다.

모든 서비스를 시작하려면 다음 스크립트를 실행하십시오:

sh docker-run.sh

기여하기 (Contributing)

학습 속도가 빠른 분야의 오픈 소스 프로젝트인 만큼, 새로운 기능 추가, 인프라 개선, 또는 더 나은 문서화 등 어떤 형태의 기여에도 열려 있습니다.

기여 방법에 대한 자세한 정보는 여기를 참고하십시오.