update user manual

0x8235 · Nov 22, 2023 · 74b000a · 74b000a
1 parent 030f25b
commit 74b000a
Show file tree

Hide file tree

Showing 50 changed files with 371 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,8 @@ If you think Holmes is helpful to you, please help by clicking <a style="display
 https://github.com/Deep-thoughtIO/Holmes/assets/151519374/d1effbe1-5c11-4c77-86ef-e01b1ea7f2f6
 
 
+## user manual
+[Holmes user manual](user_manual/en/user_manual_en.md)
 
 
 ## ✨ Features

diff --git a/README_CN.md b/README_CN.md
@@ -26,6 +26,8 @@ Holmes是一款AI原生的数据分析平台。Holmes充分利用大语言模型
 
 https://github.com/Deep-thoughtIO/Holmes/assets/151519374/f0d2fcd4-32b0-4095-a892-b9bbf8a51602
 
+## 使用说明
+[Holmes 使用说明](user_manual/cn/user_manual_cn.md)
 
 
 ## ✨ 特性

diff --git a/user_manual/cn/img/doc_0.png b/user_manual/cn/img/doc_0.png
diff --git a/user_manual/cn/img/doc_1.png b/user_manual/cn/img/doc_1.png
diff --git a/user_manual/cn/img/doc_10.png b/user_manual/cn/img/doc_10.png
diff --git a/user_manual/cn/img/doc_11.png b/user_manual/cn/img/doc_11.png
diff --git a/user_manual/cn/img/doc_12.png b/user_manual/cn/img/doc_12.png
diff --git a/user_manual/cn/img/doc_13.png b/user_manual/cn/img/doc_13.png
diff --git a/user_manual/cn/img/doc_14.png b/user_manual/cn/img/doc_14.png
diff --git a/user_manual/cn/img/doc_15.png b/user_manual/cn/img/doc_15.png
diff --git a/user_manual/cn/img/doc_16.png b/user_manual/cn/img/doc_16.png
diff --git a/user_manual/cn/img/doc_17.png b/user_manual/cn/img/doc_17.png
diff --git a/user_manual/cn/img/doc_18.png b/user_manual/cn/img/doc_18.png
diff --git a/user_manual/cn/img/doc_19.png b/user_manual/cn/img/doc_19.png
diff --git a/user_manual/cn/img/doc_2.png b/user_manual/cn/img/doc_2.png
diff --git a/user_manual/cn/img/doc_20.png b/user_manual/cn/img/doc_20.png
diff --git a/user_manual/cn/img/doc_21.png b/user_manual/cn/img/doc_21.png
diff --git a/user_manual/cn/img/doc_22.png b/user_manual/cn/img/doc_22.png
diff --git a/user_manual/cn/img/doc_3.png b/user_manual/cn/img/doc_3.png
diff --git a/user_manual/cn/img/doc_4.png b/user_manual/cn/img/doc_4.png
diff --git a/user_manual/cn/img/doc_5.png b/user_manual/cn/img/doc_5.png
diff --git a/user_manual/cn/img/doc_6.png b/user_manual/cn/img/doc_6.png
diff --git a/user_manual/cn/img/doc_7.png b/user_manual/cn/img/doc_7.png
diff --git a/user_manual/cn/img/doc_8.png b/user_manual/cn/img/doc_8.png
diff --git a/user_manual/cn/img/doc_9.png b/user_manual/cn/img/doc_9.png
diff --git a/user_manual/cn/user_manual_cn.md b/user_manual/cn/user_manual_cn.md
@@ -0,0 +1,178 @@
+<h1 align="center">Holmes 使用说明</h1>
+
+<div align="center">
+
+</div>
+
+<div align="center">
+
+Languages：中文  [English](../en/user_manual_en.md)
+
+</div>
+
+
+<h2 align="left">1，配置 API KEY</h2>
+
+- [设置]-[API KEY]
+
+### 1.1, 关于 OPENAI API KEY:
+
+- API KEY 需要 OPENAI GPT4 模型的访问权限
+- 后续会陆续支持其他大模型，敬请期待
+
+### 1.2, 关于 代理:
+
+- OPENAI API 访问可能需要科学上网,请小伙伴们自行配置代理
+
+- KEY和代理配置完毕后，配置完毕后，点击【连接测试】，显示 测试通过 即可。
+测试不通过的情况，请自行检查 API KEY是否可用，以及代理是否配置正确。
+
+![doc_0.png](img/doc_0.png)
+
+<h2 align="left">2, 配置 数据源</h2>
+
+- 目前支持的数据源有， MySql，Doris, starRocks, PostgreSql, 和 CSV
+- 后续会陆续支持更多数据源，如sqlserver，clickhouse，SQLite等，敬请期待
+
+### 2.1, CSV数据源配置:
+
+- 【设置】-【CSV数据源】-【点击上传】- 选择需上传的csv文件即可
+
+![doc.png](img/doc_1.png)
+
+### 2.2, [MySql，Doris, starRocks, PostgreSql] 数据源配置:
+
+- 【设置】-【数据源】-【新建一个数据源】
+- 选择数据源，填写数据库信息，并保存
+- 配置完毕后，点击【连接测试】，显示 连接成功 即可
+
+![doc.png](img/doc_2.png)
+
+![doc.png](img/doc_3.png)
+
+<h2 align="left">3, 数据分析</h2>
+
+<h3 align="left">3.1, [数据分析] - [对话]</h3>
+
+#### 3.1.1. 勾选数据（数据源和表）
+
+- 勾选的数据会作为对话数据分析中AI的基础数据
+
+#### 3.1.2, 填写注释，提交AI检测
+
+- 尽量完善表格和字段注释，协助AI更好的理解这些数据，使Agent更好的完成数据分析任务
+
+![doc.png](img/doc_4.png)
+
+#### 3.1.3, 修改未通过的注释，再次提交
+
+- AI会反馈未通过的注释，请修改补充后，再次提交，直到所有注释通过检测
+
+![doc.png](img/doc_5.png)
+
+#### 3.1.4, 所有注释检测通过后，开始对话
+
+- 🔥 注: 若要生成持久化报表，请使用【报表】-【报表生成】，数据分析中出现的报表均为临时报表，不支持持久化
+
+![doc.png](img/doc_6.png)
+
+#### 3.1.5, 重选数据源
+
+- 若要重选数据源，进行新一轮对话，请点击【新对话】，重置当前对话，当前对话记录会存储进【历史对话】中
+
+![doc.png](img/doc_7.png)
+
+<h3 align="left">3.2, 【数据分析】-【历史对话】</h3>
+- 可查看历史对话记录
+
+![doc.png](img/doc_8.png)
+
+<h2 align="left">4, 报表 </h2>
+
+<h3 align="left">4.1,【报表】-【报表生成】</h3>
+
+#### 4.1.1. Check the data (data source and table)
+
+- 勾选的数据会作为报表生成中AI的基础数据
+- 🔥注: 目前CSV数据源不支持【报表生成】
+
+#### 4.1.2, 填写注释，提交AI检测
+
+- 尽量完善表格和字段注释，协助AI更好的理解这些数据，使Agent更好的完成报表生成任务
+
+![doc.png](img/doc_9.png)
+
+#### 4.1.3, 修改未通过的注释，再次提交
+
+- AI会反馈未通过的注释，请修改补充后，再次提交, 直到所有注释检测通过
+
+![doc.png](img/doc_10.png)
+
+#### 4.1.4, 所有注释检测通过后，开始对话生成报表
+
+- 点击【编辑报表】，可直接编辑 新生成的报表.
+- 🔥 注: 【报表生成】模块目前仅支持持久化报表生成任务，分析类问题，请使用【数据分析】-【对话】
+
+![doc.png](img/doc_11.png)
+
+#### 4.1.5, 重选数据源 
+
+- 若要重选数据源，进行新一轮对话，请点击【新对话】，重置当前对话
+
+![doc.png](img/doc_12.png)
+
+<h3 align="left">4.2, 【报表】-【报表列表】</h3>
+
+#### 4.2.1, 报表状态
+
+- 【报表生成】中新生成的报表会出现在【报表列表】中，此时报表为 草稿 状态，若想要在【仪表盘】展示该报表，请点击 【发布】 按钮，将报表状态变更为 已发布 状态
+
+![doc.png](img/doc_13.png)
+
+![doc.png](img/doc_14.png)
+
+#### 4.2.2, 修改SQL语句
+
+- 点击【编辑源】，可自定义修改报表的SQL语句.
+
+![doc.png](img/doc_15.png)
+
+#### 4.2.3, 修改图表样式
+
+- 点击【编辑可视化】，可自定义编辑 可视化图表样式
+- 点击【新增可视化】，可增加可视化图表
+
+![doc.png](img/doc_16.png)
+
+![doc.png](img/doc_17.png)
+
+#### 4.2.4, 删除报表
+
+- 点击【归档】，可将报表状态变更为 归档（删除）状态
+
+![doc.png](img/doc_18.png)
+
+<h3 align="left">5, 仪表盘</h3>
+
+<h4 align="left">5.1, 新建仪表盘</h4>
+
+- 【仪表盘】-【新建】- 编辑仪表盘
+
+![doc.png](img/doc_19.png)
+
+- 将刚生成的【已发布 】报表，添加进仪表盘
+
+![doc.png](img/doc_20.png)
+
+- 点击【发布】仪表盘
+
+![doc.png](img/doc_21.png)
+
+<h4 align="left">5.2 分享仪表盘 </h4>
+
+- 点击【发布】后，即可分享仪表盘
+
+![doc.png](img/doc_22.png)
+
+
+
diff --git a/user_manual/en/img/doc_0.png b/user_manual/en/img/doc_0.png
diff --git a/user_manual/en/img/doc_1.png b/user_manual/en/img/doc_1.png
diff --git a/user_manual/en/img/doc_10.png b/user_manual/en/img/doc_10.png
diff --git a/user_manual/en/img/doc_11.png b/user_manual/en/img/doc_11.png
diff --git a/user_manual/en/img/doc_12.png b/user_manual/en/img/doc_12.png
diff --git a/user_manual/en/img/doc_13.png b/user_manual/en/img/doc_13.png
diff --git a/user_manual/en/img/doc_14.png b/user_manual/en/img/doc_14.png
diff --git a/user_manual/en/img/doc_15.png b/user_manual/en/img/doc_15.png
diff --git a/user_manual/en/img/doc_16.png b/user_manual/en/img/doc_16.png
diff --git a/user_manual/en/img/doc_17.png b/user_manual/en/img/doc_17.png
diff --git a/user_manual/en/img/doc_18.png b/user_manual/en/img/doc_18.png
diff --git a/user_manual/en/img/doc_19.png b/user_manual/en/img/doc_19.png
diff --git a/user_manual/en/img/doc_2.png b/user_manual/en/img/doc_2.png
diff --git a/user_manual/en/img/doc_20.png b/user_manual/en/img/doc_20.png
diff --git a/user_manual/en/img/doc_21.png b/user_manual/en/img/doc_21.png
diff --git a/user_manual/en/img/doc_22.png b/user_manual/en/img/doc_22.png
diff --git a/user_manual/en/img/doc_3.png b/user_manual/en/img/doc_3.png
diff --git a/user_manual/en/img/doc_4.png b/user_manual/en/img/doc_4.png
diff --git a/user_manual/en/img/doc_5.png b/user_manual/en/img/doc_5.png
diff --git a/user_manual/en/img/doc_6.png b/user_manual/en/img/doc_6.png
diff --git a/user_manual/en/img/doc_7.png b/user_manual/en/img/doc_7.png
diff --git a/user_manual/en/img/doc_8.png b/user_manual/en/img/doc_8.png
diff --git a/user_manual/en/img/doc_9.png b/user_manual/en/img/doc_9.png
diff --git a/user_manual/en/user_manual_en.md b/user_manual/en/user_manual_en.md
@@ -0,0 +1,189 @@
+<h1 align="center">Holmes User Manual</h1>
+
+<div align="center">
+
+</div>
+
+<div align="center">
+
+Languages： [中文](../cn/user_manual_cn.md) English
+
+
+</div>
+
+
+<h2 align="left">1，Configure API KEY</h2>
+
+- [Setting]-[API KEY]
+
+### 1.1, About OPENAI API KEY:
+
+- Requires access to gpt4 models.
+- Other large models will be supported in the future, so stay tuned.
+
+### 1.2, About the proxy:
+
+- OPENAI API access may require proxy configuration, please configure the proxy yourself.
+
+- After the KEY and proxy are configured, click [Connection Test] and "Test success" will be displayed. If the test
+  fails, please check whether the API KEY is available and whether the proxy is configured correctly.
+
+![doc_0.png](img/doc_0.png)
+
+<h2 align="left">2,Configure Data Source</h2>
+
+- Currently supported data sources are MySql, Doris, starRocks, PostgreSql, and CSV. More data sources will be supported
+  in the future, such as sqlserver, clickhouse, SQLite, etc., so stay tuned.
+
+### 2.1, CSV data source configure:
+
+- [Setting]-[CSV Data Source]-[Click to upload]-select the csv file to be uploaded
+
+![doc.png](img/doc_1.png)
+
+### 2.2, [MySql, Doris, starRocks, PostgreSql] data source configure:
+
+- [Setting]-[Data Sources]-[New Data Source]
+- Select the data source, fill in the database information, and save. After the configuration is completed,
+  click [Test Connection ] and "Connection Success" will be displayed.
+
+![doc.png](img/doc_2.png)
+
+![doc.png](img/doc_3.png)
+
+<h2 align="left">3,Chat Builder</h2>
+
+<h3 align="left">3.1, [Chat Builder] - [Dialogue]</h3>
+
+#### 3.1.1. Check the data (data source and table)
+
+- The checked data will be used as the basic data for AI in conversation data analysis.
+
+#### 3.1.2, fill in the comments and submit for AI detection
+
+- Try to improve the form and field annotations as much as possible to help AI better understand the data and enable the
+  Agent to better complete the data analysis task.
+
+![doc.png](img/doc_4.png)
+
+#### 3.1.3, modify the failed comments and submit again
+
+- AI will feedback the comments that have not passed. Please revise and add them and submit again until all the comments
+  pass.
+
+![doc.png](img/doc_5.png)
+
+#### 3.1.4, after all annotations pass the detection, start the conversation
+
+- 🔥 Note: If you want to generate a persistent report, please use [Query Builder]-[Report Generation]. The reports that
+  appear in [Chat Builder] are temporary reports and do not support persistence.
+
+![doc.png](img/doc_6.png)
+
+#### 3.1.5, reselect data source
+
+- If you want to reselect the data source and start a new round of dialogue, please click [New Dialogue] to reset the
+  current conversation. The current conversation record will be stored in [History Dialogue].
+
+![doc.png](img/doc_7.png)
+
+<h3 align="left">3.2, [Chat Builder] - [History Dialogue]</h3>
+Can view historical conversation records
+
+![doc.png](img/doc_8.png)
+
+<h2 align="left">4, Query Builder </h2>
+
+<h3 align="left">4.1, [Query Builder]-[Report Generation]</h3>
+
+#### 4.1.1. Check the data (data source and table)
+
+- The checked data will be used as the basic data of AI in report generation. 
+- 🔥Note: Currently the CSV data source does
+  not support [Report Generation]
+
+#### 4.1.2, fill in the comments and submit for AI detection
+
+- Try to improve the form and field annotations as much as possible to help AI better understand the data and enable the
+  Agent to better complete the report generation task.
+
+![doc.png](img/doc_9.png)
+
+#### 4.1.3, modify the failed comments and submit again
+
+- AI will feedback the annotations that have failed. Please revise and add them and submit again until all annotations
+  pass the test.
+
+![doc.png](img/doc_10.png)
+
+#### 4.1.4, after all annotations pass the detection, start the dialogue to generate reports
+
+- Click [Edit Report] to directly edit the newly generated report.
+- 🔥 Note: The [Report Generation] module currently only supports persistent report generation tasks. For analysis
+  questions, please use [Chat Builder] - [Dialogue].
+
+![doc.png](img/doc_11.png)
+
+#### 4.1.5, reselect data source 
+
+- If you want to reselect the data source and start a new round of dialogue, please click [New Dialogue] to reset the current dialogue.
+
+![doc.png](img/doc_12.png)
+
+<h3 align="left">4.2, [Query]-[Report List]</h3>
+
+#### 4.2.1, Report status
+
+- The newly generated report in [Report Generation] will appear in the [Report List]. At this time, the report is in
+  draft status. If you want to display the report in the [Dashboards], please click the [Publish] button, change report
+  status to published status.
+
+![doc.png](img/doc_13.png)
+
+![doc.png](img/doc_14.png)
+
+#### 4.2.2, Modify SQL statement
+
+- Click [Edit Source] to customize the SQL statement of the report.
+
+![doc.png](img/doc_15.png)
+
+#### 4.2.3, modify chart style
+
+- Click [Edit Visualization] to customize and edit the visualization chart style.
+- Click [Add Visualization] to add a visual chart.
+
+![doc.png](img/doc_16.png)
+
+![doc.png](img/doc_17.png)
+
+#### 4.2.4. Deleting a report
+
+- Click [Archive] to change the report status to archive (delete) status.
+
+![doc.png](img/doc_18.png)
+
+<h3 align="left">5, Dashboards</h3>
+
+<h4 align="left">5.1, create a new dashboard</h4>
+
+- [Dashboards]-[Create]-Edit Dashboard
+
+![doc.png](img/doc_19.png)
+
+- Add the newly generated Published report to the dashboard
+
+![doc.png](img/doc_20.png)
+
+- Click [Publish] Dashboard
+
+![doc.png](img/doc_21.png)
+
+<h4 align="left">5.2 Share Dashboard </h4>
+
+- After clicking [Publish], you can share the dashboard
+
+![doc.png](img/doc_22.png)
+
+
+