Skip to content

Commit 6948680

Browse files
committed
docs: update quick start
1 parent cff4fab commit 6948680

File tree

10 files changed

+1044
-862
lines changed

10 files changed

+1044
-862
lines changed

pages/docs/start-guide/getting-started.mdx

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
<iframe width="100%" height="500" src="https://www.youtube.com/embed/bsg3yF7al_I?si=60QprvANg_nd1U-8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
3+
<iframe width="100%" height="500" src="https://www.youtube.com/embed/ds6fWZrA6lc?si=ZDua5BZltoFPTIoM&amp;start=2" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
44

55

66
## 📖 Introduction
@@ -75,31 +75,55 @@ Different databases on the client need to download different drivers. If you nee
7575

7676
Click the test button in the lower left corner to test whether the connection is normal. If the connection is normal, the connection will be successful. Otherwise, the connection will be failed. You can adjust the connection information according to the error message. Finally click Save.
7777

78-
## Step 5: Set Up AI data collection
78+
## Step 5: Use Chat2DB database development
7979

80-
After creating the link, a pop-up window will ask if you want to set up AI data collection now.
80+
After the connection is successful, you can double-click the connection or right-click to enter the connection. Then you can add, delete, modify, and query the database in Chat2DB. You can also use our AIGC capability to directly query the database using natural language, or use SQL to convert to natural language.
8181

82-
Setting up AI data collection can better help the AI understand your database table structure, generating more accurate answers. This is also one of the major highlights of Chat2DB.
82+
### Database management
83+
Double-click the newly created connection to enter the database management interface, where you can add, delete, modify, and query the database.
84+
!['databasemanage'](/image/connection-manage/databasemanage.png)
8385

84-
Click **'affirm'** to start the setup.
86+
### Query Data with AI Copilot
8587

86-
![aidata](/image/start-guide/aidata1.png)
88+
Click the AI ​​copilot button on the right, or press Ctrl/Cmd+K to activate your AI copilot:
8789

88-
1. Select the database for which you need to create the AI data collection in the upper right corner.
90+
![ai copilot](/image/start-guide/aicopilot.png)
8991

90-
2. Check the database tables you need to sync on the left side.
92+
1. Select your data source
9193

92-
3. Click 'Sync to AI data collection' to complete the creation.
94+
2. Select your favorite model
9395

94-
![aidata](/image/start-guide/aidata2.png)
96+
3. Input the natural language to query data.
9597

96-
## Step 6: Use Chat2DB database development
98+
#### Run SQL and get result in AI Copilot
9799

98-
After the connection is successful, you can double-click the connection or right-click to enter the connection. Then you can add, delete, modify, and query the database in Chat2DB. You can also use our AIGC capability to directly query the database using natural language, or use SQL to convert to natural language.
100+
You can run the generated SQL directly in ai copilot to view the results directly:
99101

100-
### Database management
101-
Double-click the newly created connection to enter the database management interface, where you can add, delete, modify, and query the database.
102-
!['databasemanage'](/image/connection-manage/databasemanage.png)
102+
![ai copilot](/image/start-guide/runsql.png)
103+
104+
#### Paste SQL into the console
105+
106+
You can also click the button next to Run to paste the SQL into the console on the left for secondary editing.
107+
108+
![ai copilot](/image/start-guide/runsql1.png)
109+
110+
#### Invoke AI in the console
111+
112+
You can press '/' in the editor to invoke AI and easily generate SQL through natural language:
113+
114+
![ai copilot](/image/start-guide/invoke.png)
115+
116+
#### Format SQL
117+
118+
After selecting SQL, click the format button above or right-click Format SQL to format and beautify your SQL.
119+
120+
![ai copilot](/image/start-guide/formatsql.png)
121+
122+
#### Fix SQL Error with AI
123+
124+
If an error occurs after SQL running, you can directly click ‘fix in chat’ to get the correct sql result:
125+
126+
![ai copilot](/image/start-guide/fixerror.png)
103127

104128
### Data table management
105129

@@ -165,12 +189,14 @@ After that, you can choose to create the data report manually or AI generated re
165189

166190
#### 1. AI generates charts
167191

168-
Click “AI Chart”, enter the report information you want to generate in natural language in the input box that pops up in the upper right corner, and select the AI data collection you just created to generate the visualization chart:
169-
170-
!['Dashboard'](/image/start-guide/aidashboard.png)
192+
Click the AI Copilot on the right up corner, enter the chart information you want to generate in natural language in the input box, and select the corresponding data source to generate a visual chart:
171193

172194
!['Dashboard'](/image/start-guide/aidashboard2.png)
173195

196+
You can then add the chart to your dashboard:
197+
198+
!['Dashboard'](/image/start-guide/aidashboard.png)
199+
174200
#### 2. Creating charts manually
175201

176202
1. New Chart
506 KB
Loading
443 KB
Loading
442 KB
Loading

public/image/start-guide/fixerror.png

460 KB
Loading
618 KB
Loading

public/image/start-guide/invoke.png

544 KB
Loading

public/image/start-guide/runsql.png

609 KB
Loading

public/image/start-guide/runsql1.png

607 KB
Loading

0 commit comments

Comments
 (0)