topdog/supersonic
1
0
Fork 0
mirror of https://github.com/tencentmusic/supersonic.git synced 2026-01-04 08:18:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

(docs)Move docs out of source code.

Browse Source
This commit is contained in:
jerryjzhang
2024-06-19 10:07:30 +08:00
parent 0334009c70
commit 5d32235c2d
9 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -9,11 +9,11 @@ SuperSonic is the next-generation BI platform that integrates **Chat BI** (power
- Chat BI's Text2SQL gets augmented with context-retrieval from semantic models.
- Headless BI's query interface gets extended with natural language API.
<img src="./docs/images/supersonic_ideas.png" height="75%" width="75%" align="center"/>
<img src="https://github.com/supersonicbi/supersonic-website/blob/main/static/img/supersonic_ideas.png" height="75%" width="75%" />
SuperSonic provides a **Chat BI interface** that empowers users to query data using natural language and visualize the results with suitable charts. To enable such experience, the only thing necessary is to build logical semantic models (definition of metric/dimension/tag, along with their meaning and relationships) through a **Headless BI interface**. Meanwhile, SuperSonic is designed to be extensible and composable, allowing custom implementations to be added and configured with Java SPI.
<img src="./docs/images/supersonic_demo.gif" height="100%" width="100%" align="center"/>
<img src="https://github.com/supersonicbi/supersonic-website/blob/main/static/img/supersonic_demo.gif" height="100%" width="100%" />
## Motivation
@@ -40,7 +40,7 @@ With these ideas in mind, we develop SuperSonic as a practical reference impleme
The high-level architecture and main process flow is as follows:
<img src="./docs/images/supersonic_components.png" height="65%" width="65%" align="center"/>
<img src="https://github.com/supersonicbi/supersonic-website/blob/main/static/img/supersonic_components.png" height="65%" width="65%" />
- **Knowledge Base:** extracts schema information periodically from the semantic models and build dictionary and index to facilitate schema mapping.
@@ -67,16 +67,14 @@ SuperSonic comes with sample semantic models as well as chat conversations that
## Build and Development
Please refer to project [wiki](https://github.com/tencentmusic/supersonic/wiki).
Please refer to project [Docs](https://supersonicbi.github.io/docs/%E7%B3%BB%E7%BB%9F%E9%83%A8%E7%BD%B2/%E7%BC%96%E8%AF%91%E6%9E%84%E5%BB%BA/).
## WeChat Contact
Please follow SuperSonic wechat official account:
<img src="./docs/images/supersonic_wechat_oa.png" height="50%" width="50%" align="center"/>
<img src="https://github.com/supersonicbi/supersonic-website/blob/main/static/img/supersonic_wechat_oa.png" height="50%" width="50%" />
Welcome to join the WeChat community:
<img src="./docs/images/supersonic_wechat.png" height="50%" width="50%" align="center"/>
<img src="https://github.com/supersonicbi/supersonic-website/blob/main/static/img/supersonic_wechat.png" height="50%" width="50%" />